Category links

API Links

Account Holders

An Account Holder is an individual who has an account in the CoreCard system. You can use CoreCard APIs to create an account, add or remove account holder(s), and to update to account attributes. 

CoreCard has three types of account holders:

Applicant/Primary Account Holder: The main account holder who is the sole owner of the account and has the right to modify account-related attributes and is liable for making payments against the due calculated.
 

Co-applicant/Secondary Account Holder: The Co-applicant is the additional account holder who may or may not have similar rights as the primary account holder. The Co-applicant may or may not share the liabilities of the account with the primary account holder. Also, the Secondary Account Holder can have a child relation that  the primary account holder controls. In that case, the Secondary Account Holder is the only participant who enjoys rights given by the Primary Account Holder but does not have any liability to make payments. You can use CoreCard APIs to add or remove a Co-applicant/Secondary Account Holder to the account and update account control attributes to define the rights and liabilities of Co-applicants/Secondary Account Holders.
 

Co-signer: The Co-signer only shares liabilities of a Primary Account Holder in the case the Primary Account Holder does not make the payments. Also, the Primary Account Holder can benefit from the high credit score of the Co-signer while seeking a line of credit from a creditor.

CoreCard stores personal identification information (PII) data, level of controls, and specific configurations for all types of account holders. 

A card account can also be used by other participants, such as a child. A parent can limit the account-related rights and activity for the child using the CoreCard system. 

You can also create the account with the Co-applicant on it, who shares the credit facilities and liabilities related to the account. The account can also be created with a Co-signer. 

In general, a card is created for an account, which means that to have a card issued, an account is required. Card related attributes like card number (PAN), card expiry date, CVC/CVV2, and association details are linked to the card account and the card is issued to the account holder. An account holder can use the card for making payments at different merchant points of sale and online. 

You can create an account with the account holder's details and a plastic card can be issued to the account holder who represents the account. Any transaction made using the issued card affects the account balances, fees, interest levied on the account, and other considerations. You can control these attributes using the card and account control parameters.

SVG Image

Create Virtual Card

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/CreateVirtualCard

POST /api/CoreCredit/AccountHolders/CreateVirtualCard

Use this API to create virtual cards and assign the attribute such as card limit, expiry option & expiry date.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountNumber

string

Conditional

Account number of Card holder under which secondary card need to be created. Valid Values:0-9 Example:8000000000000037 Condition:Any one from Admin Number or Account Number is mandatory

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345 Condition:Any one from Admin Number or Account Number is mandatory

VirtualCardLimit

decimal

Conditional

Card limit of Virtual card Valid Values:0-9 Format:XXXX.XX Example:1000.00 Condition:This field is conditional. Virtual Card can be created without passing Virtual card limit, It can be 0 or Null.If it is 0 or Null then card will use Accounts Credit Limit.

VirtualCardResetAllow

integer

Mandatory

Flag to decide if created virtual card should get the facility to update card limit. Valid Values: 0 = Yes (Will get the facility to update card limit) 1 = No (Will not get the facility to update card limit) Format:X Example:0,1

VirtualCardExpOption

integer

Mandatory

Virtual card expiration option. Valid Values: 0 = Card expire after no.of transactions. 1 = Card expire on particular duration. 2 = Card expire on particular date. 3 = Card expiry date is same as Primary Card. This field is mandatory when Secondary Card Type is "1"(Virtual). Format: X Example: 2 (Card expire on particular date)

VirtualCardExpAfterTxn

integer

Conditional

Virtual card expiration option after certain number of transaction. Valid Values: 0-9 Format: XX Example: 10 Condition: This field is mandatory when VirtualCardExpOption is 0 (Card expire after no. of transactions)

VirtualCardExpDuration

integer

Conditional

Virtual card expiration duration like hour, minute, day etc Valid Values: 0 = Minutes 1 = Hour 2 = Day 3 = Week 4 = Month 5 = Year Format: X Example: 2 (Day) Condition: This field is mandatory when VirtualCardExpOption = 1 (Card expire on particular duration)

VirtualCardExpDurationValue

integer

Conditional

Virtual card expiration Duration Value. Valid Values: 0-9 Format: XXX Example: Virtual Card Expiry duration is 4(month) then this field value can be of 1-12. Condition: This field is mandatory when VirtualCardExpOption = 1 (Card expire on particular duration)

VirtualCardExpDate

datetime

Conditional

Virtual card expiration option at exact date. Valid Values: 0-9 Format: MM/DD/YYYY Example: 01/01/2024 Condition: This field is mandatory when VirtualCardExpOption is 2 (Card expire on particular date)

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "9000000500000170",
  "AdminNumber": 129408,
  "VirtualCardLimit": 1000.0,
  "VirtualCardResetAllow": 0,
  "VirtualCardExpOption": 3,
  "VirtualCardExpAfterTxn": null,
  "VirtualCardExpDuration": null,
  "VirtualCardExpDurationValue": null,
  "VirtualCardExpDate": null
}
Response fields detail
Fields Description

VirtualCardNumber

string

Virtual Card Number Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

AccountNumber

string

Account number of Card holder under which secondary card created. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:8000000000000037

Allowable Values:

19

AdminNumber

int64

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345

CurrentCardBalance

decimal

Available Balance of Card. Valid Values:0-9 Format:XXX.XX Example:2000.00

FirstName

string

Card holder's First name. Example:John

Allowable Values:

50

LastName

string

Card holder's last name. Example:Smith

Allowable Values:

50

NameOnCard

string

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J

Allowable Values:

50

PrimaryCardExpiryDate

datetime

Expiry date of primary card under which secondary card is being created. Valid Values:0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

ValidFrom

datetime

Card Creation Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2020

ValidTo

datetime

Card Expiration Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2022

CVC

string

3 Digit security number printed on back side of the card. Valid Values:0-9 Format:XXX Example:456

Allowable Values:

3

VirtualCardExpirationDate

datetime

Card Expiration Date of Virtual card. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

Sample response body 

{
  "application/json": {
    "Message": "Card created successfully.",
    "Status": true,
    "ErrorCode": "ERR01070",
    "ResponseData": {
      "VirtualCardNumber": "XXXXXXXXXXXXXXXX",
      "AccountNumber": "7000000000000146",
      "AdminNumber": 129475,
      "CurrentCardBalance": 1000.0,
      "FirstName": "John",
      "LastName": "Miller",
      "NameOnCard": "John Miller",
      "PrimaryCardExpiryDate": "11/02/2022 00:00:00",
      "ValidFrom": "11/02/2020 00:00:00",
      "ValidTo": "11/02/2022 00:00:00",
      "CVC": "XXX",
      "VirtualCardExpirationDate": "11/02/2020 00:00:00"
    }
  }
}

Account Creation

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/AccountCreation

POST /api/CoreCredit/AccountHolders/AccountCreation

Use this API to create accounts in the CoreCARD platform, with or without a co-applicant. New accounts may be created for a specific product or partner (StoreID). The API captures required personal information for the account holder and co-applicant (if applicable), including address and employment information. This API also allows for the creation of a digital or a plastic card.

Note

The successful creation of an account requires all the mandatory details to be provided. If the required information is not provided, then the account is not created.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

ProductID

integer

Mandatory

Product ID of the product for which account is to be created. Valid Values: As provided by CoreCard. Example: 1234

MerchantID

integer

Optional

Unique number of merchant account. Valid Values: As provided by CoreCard. Example: 35632

StoreID

integer

Mandatory

ID of the Store where account is to be created. Valid Values: As provided by CoreCard Example: 13432

CreditLimit

decimal

Mandatory

Credit Limit of account. Valid Values: 0-9 Format: XXXXXX Example: 500.00

Title

string

Optional

Title of the Applicant. Valid Values: Refer Appendix Section - Title Values Example: 02

Allowable Values:

5

FirstName

string

Conditional

Applicant's First name. Valid Values: A-Z,0-9 Example: John Condition: If PII information is set as mandatory on product, then this tag is mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

40

MiddleName

string

Optional

Applicant's Middle Name Valid Values: A-Z Example: K Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

10

LastName

string

Conditional

Applicant's last name. Valid Values: A-Z Example:LEE Condition: If PII information is set as mandatory on product, then this tag is mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

40

SurnameSuffix

string

Optional

Applicant's surname-suffix

Allowable Values:

5

AddressLine1

string

Conditional

Applicant's address line 1. Valid Values: A-Z, 0-9 Example: 123 HWY Condition: If PII information is set as mandatory on product, then this tag is mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

AddressLine2

string

Optional

Applicant's address line 2. Valid Values: A-Z,0-9 Example: Park Avenue Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

State

string

Conditional

Applicant's State name. Valid Values: Refer Appendix Section State Codes Example: AK Condition: If PII information is set as mandatory on product, then this tag is mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

30

City

string

Conditional

City name of the applicant's address. Example: Los Angeles Condition: If PII information is set as mandatory on product, then this tag is mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

35

PostalCode

string

Conditional

Postal code of the applicant's address. Valid Values: 0-9 Example: 46206 Condition: If PII information is set as mandatory on product, then this tag is mandatory.

Allowable Values:

9

Country

string

Conditional

Country name of the applicant's address. Valid Values: Refer appendix section Country Code Values Example: US Condition: If PII information is set as mandatory on product, then this tag is mandatory.

Allowable Values:

3

EmailID

string

Conditional

Applicant's email id. Valid Values:A-Z, 0-9 Format: XXX@XXX.XXX Example: abc@gmail.com Condition: If email is set as mandatory on product, then this tag is mandatory.

Allowable Values:

300

LanguageIndicator

string

Optional

Language indicatior Valid Values: 'en' Example: 'en'

Allowable Values:

5

HomePhoneNumber

string

Conditional

Applicant's Home Phone number. Valid Values: 0-9 Format: XXXXXXXXXX Example: 7895463241 Condition: If Home Phone is set as mandatory on product, then this tag is mandatory.

Allowable Values:

15

WorkPhoneNumber

string

Conditional

Applicant's Work phone number Valid Values: 0-9 Format: XXXXXXXXXXX Example: 5678909876 Condition: This is mandatory only for selective products as per value of PID.

Allowable Values:

15

MobilePhoneNumber

string

Conditional

Applicant's Mobile Phone Number. Valid Values: 0-9 Format: XXXXXXXXXX Example: 987567757 Condition: If Mobile Phone Number is set as mandatory on product, then this tag is mandatory.

Allowable Values:

15

OtherPhoneNumber

string

Optional

Applicant's other Phone Number. Valid Values: 0-9 Format: XXXXXXXXXX Example: 987567757

Allowable Values:

15

DateOfBirth

DateTime

Conditional

Applicant's Date of Birth. Format: MM/dd/YYYY Example: 07/25/1991 Condition: If PII information is set as mandatory on product, then this tag is mandatory.

EmployerName

string

Mandatory

Applicant's employer name. Valid Values: A-Z, 0-9

Allowable Values:

100

EmployeeNumber

string

Optional

Applicant's employer number

Allowable Values:

15

EmployerPhoneNumber

string

Optional

Applicant's employer Phone number Valid Values: 0-9 Format: XXXXXXXXXX Example: 987567757

Allowable Values:

15

EmployerFaxNumber

string

Optional

Applicant's employer Fax number. Valid Values: A-Z,0-9 Format: XXXXXXXXXX Example: 34232

Allowable Values:

15

MotherMaidenName

string

Optional

Applicant's Mother Maiden Name Valid Values: A-Z Example: Johnson

Allowable Values:

50

SocialSecurityNumber

string

Mandatory

Applicant's Social Security Number Format: AAAGGSSSS Example: 078051120

Allowable Values:

9

IDType

string

Optional

Type of Government issued identification. Valid Values:Refer Appendix section 5.2 Example: 10

Allowable Values:

25

IDNumber

string

Conditional

Government issued identification number. Valid Values:A-Z, 0-9 Example:CDDA97418Q Condition:This field is mandatory when ID Type is having a valid value.

Allowable Values:

18

IDIssueDate

DateTime

Conditional

Issue date of ID card. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition:This field is mandatory when ID Type is having a valid value.

IDExpirationDate

DateTime

Conditional

Government issued identification expiration date. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: This field is mandatory when ID Type is having a valid value.

IDIssueCountry

string

Conditional

Government identification issued country. Valid Values: Refer Appendix Section Country Code Values Example: US Condition: This field is mandatory when ID Type is having a valid value.

Allowable Values:

3

IDIssueState

string

Conditional

Government identification issued state. Valid Values: Refer Appendix Section State Codes Example: AL Condition: This field is mandatory when ID Type is having a valid value.

Allowable Values:

3

RegulationOFlag

string

Optional

Regulation O Flag to classify RegO Account Valid Values: 1 = YES, 0 = NO

Allowable Values:

2

RegulationOFlagEffectiveDate

datetime

Conditional

Date of effective Reg 'O' Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: RegulationOFlagEffectiveDate is mandatory when RegulationOFlag = 1

BillingTable

integer

Optional

ID of the Billing Table to be assigned on account. Valid Values: As provided by CoreCard Example: 1234 Condition:If no value is provided then default Billing Table(basis criteria defined on Billing Group) will get assigned to Account

NumberofCardsRequested

integer

Optional

Number of Cards Requested. Valid Values: 0-9 Format: XX Example: 02

EmbossingLine4

string

Optional

Embossing line4 Valid Values: A-Z Example: abc Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

20

BillingCycle

string

Optional

Biiling cycle Valid Values: 1-31 Example: 10

Allowable Values:

20

NameOnCard

string

Optional

Name to be printed on the card. Name to be embossed on card If there no input for this parameter then API would by default bring First Name +Initial Middle Name+ Last Name Valid Values: A-Z Example: John J Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

TotalAnnualIncome

decimal

Mandatory

Total Annual Income of applicant. Valid Values: 0-9 Format: XXX.XX Example: 500.00

CurrentEmploymentMonths

string

Mandatory

Number of months in current employment. Valid Values: 0-9 Example: 10

Allowable Values:

10

Position

string

Optional

Employement position of the applicant. Valid Values: A-Z, 0-9 Example: Manager

Allowable Values:

100

EmploymentType

string

Mandatory

Type of employement of applicant Valid Values:Refer Appendix Section - Employement Type Example: 1

Allowable Values:

5

ResidenceType

string

Optional

Type of Residince that applicant lives in. Valid Values:Refer Appendix Section - Residence Ownership Code Example: 1

Allowable Values:

1

MonthsAtResidence

integer

Mandatory

Duration on residence in months. Valid Values: 0-9 Example: 50

YearsAtResidence

string

Optional

Duration on residence in years. Valid Values: 0-9 Example: 5

Allowable Values:

4

CompanyName

string

Optional

Company Name Valid Values: A-Z Example: abc Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

26

CompanyNumber

string

Optional

Company Number Valid Values: 0-9 Example: 1234

Allowable Values:

7

CompanyPrimaryContact

string

Optional

Company Primary Contact number. Valid Values: 0-9 Example: 4785885585

Allowable Values:

15

CompanyPhoneNumber

string

Optional

Company's Phone number. Valid Values: 0-9 Example: 7895463214

Allowable Values:

15

CompanyFaxNumber

string

Optional

Company's Fax number. Valid Values: 0-9 Example: 7895463214

Allowable Values:

15

CorporateAccountNumber

string

Optional

Corporate Account Number. Valid Values: 0-9 Example: 10585858444

Allowable Values:

19

QRCode

string

Conditional

QRCode Condition: If QR Code is set as mandatory on product, then this tag is mandatory.

Allowable Values:

50

CashCreditLimit

decimal

Optional

Cash Credit Limit of account. Valid Values: 0-9 Format: XXX.XX Example: 500.00

ShippingAddressFlag

string

Optional

Shipping address is existing or new. Valid Values: 0,1 Example: Ship to Existing Address: 0, Ship Address: 1

Allowable Values:

1

ShippingAddressLine1

string

Conditional

Shipping address line 1. Valid Values : A-Z, 0-1 Example: 2354 Main road Condition: If ShippingAddressFlag is 1 then it is mandatory Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingAddressLine2

string

Optional

Shipping address line 2. Valid Values : A-Z, 0-1 Example: xyz Avenue Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

50

ShippingCity

string

Conditional

Shipping address city name. Valid Values : A-Z Example: chicago Condition: If ShippingAddressFlag is 1 then it is mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

40

ShippingState

string

Conditional

State of the shipping address. Valid Values : Refer Appendix Section State Codes Condition: If ShippingAddressFlag is 1 then it is mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

40

ShippingCountry

string

Conditional

Shipping address Country name. Valid Values: Refer Appendix Section Country Code Values Condition: If ShippingAddressFlag is 1 then it is mandatory

Allowable Values:

10

ShippingPostalCode

string

Conditional

Zip code of the shipping address. Valid Values : 0-9 Example: 48521 Condition: If ShippingAddressFlag is 1 then it is mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

9

HoldEmbossing

string

Optional

Hold Embossing. Valid Values: 1= YES, 0 = NO

Allowable Values:

2

StatementProduction

string

Optional

Statement prduction to be process normally, online only or hold statement. Valid Values: 0 = Process normally, 1 = Online only, 2 = Hold statement Example: 0

Allowable Values:

2

IsMLAAccount

string

Optional

Identify whether the account is MLA type or not. Valid Values: Yes-1, No-0 Example: 0

Allowable Values:

1

CardImageID

string

Optional

Based on this physical card’s art will be generate. Valid Values: 0-9 Example: 12

Allowable Values:

100

SignatureID

string

Conditional

This tag is to capture the user signature image file URL. Valid Values: 0-9,A-Z Condition: If Signature ID is set as mandatory on product, then this tag is mandatory.

Allowable Values:

50

ActivationCode

string

Optional

Security Code provided at the time of Account Creation/Registration.

Allowable Values:

50

NameOnTrack

string

Optional

Name to be printed on the card. Valid Values: A-z Example: John J Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor.

Allowable Values:

26

PromoPurchaseAllow

integer

Optional

Weather to allow Promo Purchase on account or not. Valid Values: 0=No, 1=Yes Example: 0

CoApplicantFlag

string

Optional

Co-Applicant is required or not. Valid Values: 0-No,1-Yes

Allowable Values:

1

CoApplicantFirstName

string

Conditional

Co-Applicant’s First Name. Valid Values: A-Z,0-9 Example: John Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

40

CoApplicantMiddleName

string

Optional

Co-Applicant’s Middle Name Valid Values: A-Z,0-9 Example: Smith

Allowable Values:

40

CoApplicantLastName

string

Conditional

Co-Applicant’s Last Name Valid Values: A-Z,0-9 Example: Davis Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

40

CoApplicantAddressLine1

string

Conditional

Co-Applicant’s Address line1 Valid Values: A-Z, 0-9 Example: 123 HWY Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

50

CoApplicantAddressLine2

string

Optional

Co-Applicant’s Address line2 Example: Park Avenue

Allowable Values:

50

CoApplicantCity

string

Conditional

Co-Applicant’s city name. Valid Values: A-Z,0-9 Example: Chicago Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

25

CoApplicantState

string

Conditional

Co-Applicant’s State. Valid Values: Refer Appendix Section State Codes. Example: AL Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

3

CoApplicantPostalCode

string

Conditional

Co-Applicant’s postal code. Valid Values: 0-9 Example: 12345-6789 Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

10

CoApplicantHomePhoneNumber

string

Conditional

Co-Applicant’s Home Phone Number Valid Values: 0-9 Example: 7548264758 Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

15

CoApplicantMobilePhoneNumber

string

Conditional

Co-Applicant’s cell phone number. Valid Values: 0-9 Example: 7548264758 Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

15

CoApplicantEmailID

string

Conditional

Co-Applicant’s Email id Example: user1@gmail.com Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

255

CoApplicantSSN

integer

Conditional

Co-Applicant’s Social Security number. Valid Values: 0-9 Example: 123456789 Condition: If Co-Applicant Flag = 1 then mandatory.

CoApplicantDateOfBirth

datetime

Conditional

Co-Applicant’s Date of birth. Format: MM/DD/YYYY Example: 12/25/1994 Condition: If Co-Applicant Flag = 1 then mandatory.

CoApplicantCombinedTotalIncome

decimal

Conditional

Co-Applicant’s Combined Total Income. Valid Values: 0-9 Format: XXX.XX Example: 500.00 Condition: If Co-Applicant Flag = 1 then mandatory.

CoApplicantWorkPhoneNumber

string

Conditional

Co-Applicant’s work phone number. Valid Values:0-9 Example:784565412 Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

20

CoApplicantResidenceType

string

Conditional

Co-Applicant’s Residence Type Valid Values:Refer Appendix Section - Residence Ownership Code Condition: If Co-Applicant Flag = 1 then mandatory.

Allowable Values:

50

CoApplicantRentMortgageAmount

decimal

Optional

Co-Applicant’s rent mortgage amount Valid Values: 0-9 Example: 500.00

UserFieldValue1

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue2

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue3

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue4

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue5

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue6

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue7

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue8

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue9

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue10

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue11

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue12

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue13

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue14

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue15

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue16

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue17

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue18

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue19

string

Optional

User Defined Tag

Allowable Values:

40

UserFieldValue20

string

Optional

User Defined Tag

Allowable Values:

40

IgnoreDuplicateCheck

integer

Optional

To decide if Duplicate Check should honor while Account Creation or not. Valid Values: 1- Duplicate Check 0- By-Pass Duplicate Check Example: 0 Condition: If no value pass in this field then default should be consider as 1-Duplicate Check.

IsApplicantMLA

integer

Conditional

Flag to identify Applicant as MLA Valid Values: 0-9 Format: xx Example: 0/1

IsCosignerMLA

integer

Conditional

Flag to identify Cosigner as MLA Valid Values: 0-9 Format: xx Example: 0/1

CosignerFlag

integer

Optional

Flag to add Cosigner on Account Creation Valid Values:0-No,1-Yes Example: 0

CosignerTitle

string

Optional

Cosigner's Title. Valid Values:Refer Appendix Section - Title Values Format: xx Example: 01

Allowable Values:

10

CosignerFirstName

string

Conditional

Cosigner's First Name valid Values:A-Z,0-9 Example:John Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

50

CosignerMiddleName

string

Optional

Cosigner's Middle Name valid Values:A-Z,0-9 Example:Smith

Allowable Values:

50

CosignerLastName

string

Conditional

Cosigner's Last Name valid Values:A-Z,0-9 Example:Davis Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

50

CosignerAddressLine1

string

Conditional

Cosigner's Address Line 1 valid Values:A-Z, 0-9 Example:123 HWY Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

50

CosignerAddressLine2

string

Optional

Cosigner's Address Line 2 valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

CosignerCity

string

Conditional

Cosigner's City valid Values:A-Z,0-9 Example:Chicago Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

25

CosignerState

string

Conditional

Cosigner's State valid Values: Refer Appendix Section State Codes Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

50

CosignerPostalCode

int64

Conditional

Cosigner's Postal Code valid Values:0-9 Format:XXXXX Example:99501 Condition:If CosignerFlag = 1 then mandatory.

CosignerCountry

string

Conditional

Cosigner's Country Valid Values:Refer appendix section Country Code Values Example:US Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

50

CosignerLanguageIndicator

string

Optional

Cosigner's preferred language. valid Values:A-Z,a-z Format: xx Example:English

Allowable Values:

5

CosignerEmailID

string

Conditional

Cosigner's Email ID Valid Values: 0-9 a-z Format:xxx@xxx.xxx Example:abc@xyz.com Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

50

CosignerHomePhoneNumber

string

Optional

Cosigner's Home Phone Number valid Values:0-9 Format:XXXXXXXXXX Example:9974865836

Allowable Values:

15

CosignerWorkPhoneNumber

string

Optional

Cosigner's Work Phone Number valid Values:0-9 Format:XXXXXXXXXX Example:9758356383

Allowable Values:

15

CosignerMobilePhoneNumber

string

Conditional

Cosigner's Mobile Phone Number. valid Values:0-9 Format:XXXXXXXXXX Example:784565412 Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

15

CosignerAlternatePhoneNumber

string

Optional

Cosigner's Alternate Phone Number valid Values:0-9 Example:9738758349

Allowable Values:

15

CosignerDateOfBirth

DateTime

Optional

Cosigner's date of birth valid Values:0-9 Format: MM/dd/YYYY Example:11/23/1980

CosignerSSN

int64

Conditional

Cosigner's Social Security Number Valid Values:0-9 Format:XXXXXXXXX Example:987456321 Condition:If CosignerFlag = 1 then mandatory.

CosignerGovernmentIDType

string

Optional

Government issued identification Type.Government Id Type Code should be passed in the request and not the description. Valid Values:Refer Appendix section ID Type Values Example:03

Allowable Values:

25

CosignerIDNumber

string

Conditional

Cosigner's Government ID Number Valid Values:A-Z Format:XXXXXXXX Example::CDDT9741Q Condition:If CosignerFlag = 1 and 'CosignerGovernmentIDType' has any value, then it is mandatory.

Allowable Values:

20

CosignerIDIssueDate

DateTime

Conditional

Cosigner’s Government ID Issue Date Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2020 Condition:If CosignerFlag = 1 and 'CosignerGovernmentIDType' has any value, then it is mandatory.

CosignerIDExpirationDate

DateTime

Conditional

Cosigner’s Government ID Expiry Date Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2025 Condition:If CosignerFlag = 1 and 'CosignerGovernmentIDType' has any value, then it is mandatory.

CosignerIDIssueCountry

string

Conditional

Cosigner's ID Issue Country valid Values:A-Z,a-z Example:US Condition:If CosignerFlag = 1 and 'CosignerGovernmentIDType' has any value, then it is mandatory.

Allowable Values:

20

CosignerIDIssueState

string

Conditional

Cosigner's ID Issue State valid Values:A-Z,a-z Example:Alabama Condition:If CosignerFlag = 1 and 'CosignerGovernmentIDType' has any value, then it is mandatory.

Allowable Values:

20

CosignerCombinedTotalIncome

decimal

Conditional

Cosigner's Combined Total Income valid Values:0-9 Example:10000 Condition:If CosignerFlag = 1 then mandatory.

CosignerEmployerName

string

Conditional

Cosigner's Employer Name. valid Values:A-Z,0-9 Example:john Condition:Report the name of the employer for the consumer reported in the Base Segment in CBR

Allowable Values:

50

CosignerEmployeeNumber

string

Optional

Cosigner's Employee Number Valid Values: 0-9 Format: XXXXXXXXXX Example: 7895463214

Allowable Values:

25

CosignerEmploymentType

int64

Conditional

Type of employement of Cosigner. Valid Values: Refer Appendix section 5.35 Format: xxxxx Example: 1 Condition:If CosignerFlag = 1 then mandatory.

CosignerResidenceType

string

Conditional

Cosigner's Residence Type Valid Values:Refer Appendix Section - Residence Ownership Code Condition:If CosignerFlag = 1 then mandatory.

Allowable Values:

25

CosignerEmployerPhoneNumber

string

Optional

Cosigner's Employer Phone Number Valid Values: 0-9 Format: XXXXXXXXXX Example: 789654121

Allowable Values:

15

CosignerStatementProduction

integer

Optional

Statement prduction to be process normally, online only or hold statement Valid Values:0 = Process normally, 1 = Online only, 2 = Hold statement Format: XXXXXXXXXX Example: 0,1,2

CosignerMotherMaidenName

string

Optional

Cosigner's mother Maiden Name Valid ValuesA-Z, 0-9 Format:XXXX Example:Johnson

Allowable Values:

50

CosignerCurrentEmploymentMonths

integer

Optional

Cosigner's Number of months in current employment valid Values:0-9 Format:XX Example:32

CosignerPosition

string

Optional

Employement position of the Cosigner. valid Values:A-Z,0-9 Example:Manager

Allowable Values:

50

CosignerRentMortgageAmt

decimal

Optional

Cosigner’s rent mortgage amount valid Values:0-9 Format:XXX.XX Example:500.00

CosignerMobileCarrier

string

Optional

Cosigner's Mobile carrier company Valid Values:A-z, 0-9 Format:XXXXXXXX Example: c.vodafone.ne.jp, csouth1.com, m1.com.sg

Allowable Values:

50

DeliveryMechanism

string

Optional

Method through which card shipment to be deliver by embossing vendor. Valid Values: 0-Standard 1-Priority 2-Overnight Example:0 Condition:1. Default value for this tag is '0-Standard'. 2. If a new method is added then Corecard will communicate the code of it.

Allowable Values:

5

CustomerID

string

Optional

Unique ID associated with Customer. Valid Values:0-9 a-z Format:XXXXXXXX Example:abc2123

Allowable Values:

25

ReferenceAccountNumber

string

Conditional

Existing account number of cardholder/AccountHolder. Valid Values:0-9 Example:7314145404 Condition: Mandatory when PartnerID value is provided.

Allowable Values:

19

PartnerID

string

Conditional

Entity created for MID mapping and used for validation of pre-purchase. Valid Values: 0-9,A-Z Example : abc2123 Condition: Mandatory when flag 'Allow New Account Creation by validating Partner ID' on Loan product is Yes.

Allowable Values:

250

PlanID

string

Conditional

ID of the plan for which account is to be created (CPM ID). Valid Values:0-9 a-z Example:abc2123 Condition: Mandatory when PartnerID value is provided.

Allowable Values:

100
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": "840",
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "ProductID": 1341,
  "MerchantID": null,
  "StoreID": 7041,
  "CreditLimit": 1000.0,
  "Title": "03",
  "FirstName": "Test",
  "MiddleName": "H",
  "LastName": "Test",
  "SurnameSuffix": "II",
  "AddressLine1": "test",
  "AddressLine2": "test",
  "State": "AK",
  "City": "AK",
  "PostalCode": "85645",
  "Country": "US",
  "EmailID": "test.test@corecard.com",
  "LanguageIndicator": "en",
  "HomePhoneNumber": "9754413354",
  "WorkPhoneNumber": null,
  "MobilePhoneNumber": null,
  "OtherPhoneNumber": null,
  "DateOfBirth": "03/31/1980",
  "EmployerName": null,
  "EmployeeNumber": null,
  "EmployerPhoneNumber": null,
  "EmployerFaxNumber": null,
  "MotherMaidenName": null,
  "SocialSecurityNumber": "882680935",
  "IDType": null,
  "IDNumber": null,
  "IDIssueDate": null,
  "IDExpirationDate": null,
  "IDIssueCountry": null,
  "IDIssueState": null,
  "RegulationOFlag": null,
  "RegulationOFlagEffectiveDate": null,
  "BillingTable": 2181,
  "NumberofCardsRequested": null,
  "EmbossingLine4": null,
  "BillingCycle": "31",
  "NameOnCard": "test t test2",
  "TotalAnnualIncome": 100000.0,
  "CurrentEmploymentMonths": null,
  "Position": null,
  "EmploymentType": null,
  "ResidenceType": null,
  "MonthsAtResidence": null,
  "YearsAtResidence": null,
  "CompanyName": null,
  "CompanyNumber": null,
  "CompanyPrimaryContact": null,
  "CompanyPhoneNumber": null,
  "CompanyFaxNumber": null,
  "CorporateAccountNumber": null,
  "QRCode": null,
  "CashCreditLimit": null,
  "ShippingAddressFlag": null,
  "ShippingAddressLine1": null,
  "ShippingAddressLine2": null,
  "ShippingCity": null,
  "ShippingState": null,
  "ShippingCountry": null,
  "ShippingPostalCode": null,
  "HoldEmbossing": null,
  "StatementProduction": null,
  "IsMLAAccount": null,
  "CardImageID": null,
  "SignatureID": null,
  "ActivationCode": null,
  "NameOnTrack": null,
  "PromoPurchaseAllow": null,
  "CoApplicantFlag": null,
  "CoApplicantFirstName": null,
  "CoApplicantMiddleName": null,
  "CoApplicantLastName": null,
  "CoApplicantAddressLine1": null,
  "CoApplicantAddressLine2": null,
  "CoApplicantCity": null,
  "CoApplicantState": null,
  "CoApplicantPostalCode": null,
  "CoApplicantHomePhoneNumber": null,
  "CoApplicantMobilePhoneNumber": null,
  "CoApplicantEmailID": null,
  "CoApplicantSSN": null,
  "CoApplicantDateOfBirth": null,
  "CoApplicantCombinedTotalIncome": null,
  "CoApplicantWorkPhoneNumber": null,
  "CoApplicantResidenceType": null,
  "CoApplicantRentMortgageAmount": null,
  "UserFieldValue1": null,
  "UserFieldValue2": null,
  "UserFieldValue3": null,
  "UserFieldValue4": null,
  "UserFieldValue5": null,
  "UserFieldValue6": null,
  "UserFieldValue7": null,
  "UserFieldValue8": null,
  "UserFieldValue9": null,
  "UserFieldValue10": null,
  "UserFieldValue11": null,
  "UserFieldValue12": null,
  "UserFieldValue13": null,
  "UserFieldValue14": null,
  "UserFieldValue15": null,
  "UserFieldValue16": null,
  "UserFieldValue17": null,
  "UserFieldValue18": null,
  "UserFieldValue19": null,
  "UserFieldValue20": null,
  "IgnoreDuplicateCheck": 1,
  "IsApplicantMLA": null,
  "IsCosignerMLA": null,
  "CosignerFlag": null,
  "CosignerTitle": null,
  "CosignerFirstName": null,
  "CosignerMiddleName": null,
  "CosignerLastName": null,
  "CosignerAddressLine1": null,
  "CosignerAddressLine2": null,
  "CosignerCity": null,
  "CosignerState": null,
  "CosignerPostalCode": null,
  "CosignerCountry": null,
  "CosignerLanguageIndicator": null,
  "CosignerEmailID": null,
  "CosignerHomePhoneNumber": null,
  "CosignerWorkPhoneNumber": null,
  "CosignerMobilePhoneNumber": null,
  "CosignerAlternatePhoneNumber": null,
  "CosignerDateOfBirth": null,
  "CosignerSSN": null,
  "CosignerGovernmentIDType": null,
  "CosignerIDNumber": null,
  "CosignerIDIssueDate": null,
  "CosignerIDExpirationDate": null,
  "CosignerIDIssueCountry": null,
  "CosignerIDIssueState": null,
  "CosignerCombinedTotalIncome": null,
  "CosignerEmployerName": null,
  "CosignerEmployeeNumber": null,
  "CosignerEmploymentType": null,
  "CosignerResidenceType": null,
  "CosignerEmployerPhoneNumber": null,
  "CosignerStatementProduction": null,
  "CosignerMotherMaidenName": null,
  "CosignerCurrentEmploymentMonths": null,
  "CosignerPosition": null,
  "CosignerRentMortgageAmt": null,
  "CosignerMobileCarrier": null,
  "DeliveryMechanism": null,
  "CustomerID": "78515",
  "ReferenceAccountNumber": null,
  "PartnerID": null,
  "PlanID": null
}
Response fields detail
Fields Description

ResponseID

string

This number will ensure that API hit our internal servers. This will always be unique.API is returned from our external server

Allowable Values:

15

TerminalID

string

Terminal ID

Allowable Values:

10

RecordType

integer

Record type

ProductType

string

This tag reflect the product type

Allowable Values:

25

FirstName

string

Applicant's First name. Valid Values: A-Z,0-9 Example: John

Allowable Values:

40

MiddleName

string

Applicant's Middle Name Valid Values: A-Z Example: K

Allowable Values:

10

LastName

string

Applicant's last name. Valid Values: A-Z Example:LEE

Allowable Values:

40

AccountNumber

string

This tag reflects the account number.

Allowable Values:

19

CardNumber

string

This tag reflects the Card Number.

Allowable Values:

19

AdminNumber

int64

This tag reflects the Admin number.

CustomerID

string

This tag reflects the customer ID

Allowable Values:

25

CompanyName

string

Company Name

Allowable Values:

26

CompanyNumber

string

Company Number

Allowable Values:

7

CorporateAccountNumber

string

Corporate Account Number

Allowable Values:

19

AccountCreationDate

DateTime

Date Of Account creation. Format: MM/dd/YYYY Example: 11/23/2013

AccountCreationTime

string

Time of Account Creation

Allowable Values:

20

EmailID

string

Applicant's email id. Valid Values:A-Z, 0-9 Format: XXX@XXX.XXX Example: abc@gmail.com

Allowable Values:

300

UniversalUniqueID

string

Universal Unique Identification Number generated by system From StatementHeader Example: 233d6bc3-9242-11e8-82e3-509a4c38ceea

Allowable Values:

50

AdminUniversalUniqueID

string

AccountUniversal Unique Identification Number generated by system From BSegment Example:a585f533-0d33-4282-ab98-4852146e5e17

Allowable Values:

50

Sample response body 

{
  "application/json": {
    "Message": "Account Creation Successful",
    "Status": true,
    "ErrorCode": "ERR01002",
    "ResponseData": {
      "ResponseID": "108422228",
      "TerminalID": "WEB",
      "RecordType": 55,
      "ProductType": "B",
      "FirstName": "test",
      "MiddleName": "H",
      "LastName": "test",
      "AccountNumber": "5000000000004803",
      "CardNumber": "46166823******1124",
      "AdminNumber": 101538,
      "CustomerID": "77263",
      "CompanyName": null,
      "CompanyNumber": "0",
      "CorporateAccountNumber": null,
      "AccountCreationDate": null,
      "AccountCreationTime": "05:43:56",
      "EmailID": "teststest@corecard.com",
      "UniversalUniqueID": "1d90a7dd-d999-4eab-8838-ea08ee458aae",
      "AdminUniversalUniqueID": "cccfeea0-41bf-457b-aa7c-2f1c8156181c"
    }
  }
}

Create Secondary Card

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/CreateSecondaryCard

POST /api/CoreCredit/AccountHolders/CreateSecondaryCard

The CreateSecondaryCard API creates a secondary or virtual card in a single step. Certain information is required depending upon the card type, such as cardholder details, a shipping address, and card expiry date (if applicable).

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountNumber

string

Conditional

Account number of Card holder under which secondary card need to be created. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: Any one from Admin Number or Account Number is mandatory

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345 Condition:Any one from Admin Number or Account Number is mandatory

SecondaryCardType

string

Mandatory

Type of Secondary Card. Valid Values: 0 -Regular Secondary Card 1- Virtual Card

Allowable Values:

25

Title

string

Optional

Title of the cardholder. Example: Mr

Allowable Values:

5

FirstName

string

Conditional

Card holder's First name. Example:John Condition:Required only when HoldEmbossing tag value is 0(NO), means physical card need to be generate

Allowable Values:

40

MiddleName

string

Optional

Card holder's Middle Name. Example: LEE

Allowable Values:

10

LastName

string

Conditional

Card holder's Last Name. Valid Values:A-Z Example:Smith Condition: Required only when HoldEmbossing tag value is 0(NO), means physical card need to be generate

Allowable Values:

40

SurnameSuffix

string

Optional

Cardholder's surname-suffix. Valid Values:Sr/Jr Example:Sr

Allowable Values:

25

DateOfBirth

datetime

Conditional

Card Holder's Date of Birth Valid Values: 0-9 Format: MM/DD/YYYY Example: 02012020 Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

AddressLine1

string

Conditional

Card Holder's address line 1. Valid Values:A-Z, 0-9 Format: Example:123 HWY Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

50

AddressLine2

string

Conditional

Card holder's address line 2. Valid Values: A-Z, 0-9 Format: Example:Park Avenue Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

50

City

string

Conditional

City name of the Card holder's address. Example: Los Angeles Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

35

Country

string

Conditional

Country name of the Card holder's address Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

25

PostalCode

string

Conditional

Postal code of the card holder's address. Valid Values:0-9 Format:XXXXX Example:46206 Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

9

State

string

Conditional

State of the card holder address. Format:XXXXX Example: Virginia Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

30

ShippingAddressFlag

integer

Optional

Shipping address is existing or new. Valid Values:0,1,2 Format:X Example: 0 = Ship to Existing Address, 1 = Ship Address,2 = Primary Shipping Address Condition: Default value would be 2 = Primary Shipping Address

HomePhoneNumber

string

Conditional

Card holder Home Phone number. Valid Values:0-9 Format:XXXXXXXXXX Example:7895463214 Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

15

WorkPhoneNumber

string

Optional

Card holder Work phone number. Valid Values:0-9 Format:XXXXXXXXXXX Example:5678909876

Allowable Values:

15

MobilePhoneNumber

string

Optional

Card holder Mobile Phone Number. Valid Values:0-9 Format:XXXXXXXXXX Example:987567757

Allowable Values:

15

MobileCarrier

string

Optional

Carrier of Mobile Phone number. Valid Values:a-z,0-9 Format:XXXXXX Example: T-Mobile

Allowable Values:

50

LanguageIndicator

string

Optional

Language Indicator.

Allowable Values:

50

EmailID

string

Optional

Card Holder's email Address Format: XXX @xx.com Example:ABC @gmail.com Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

Allowable Values:

50

SSN

string

Optional

Card holder's Social Security Number. Format:AAAGGSSSS Example:078051120

Allowable Values:

9

IDNumber

string

Conditional

Card holder's Government ID Number. Format:AAAGGSSSS Example: 078051120 Condition: Required only when SecondaryCardType = 0 (Regular Secondary Card)

Allowable Values:

50

MotherMaidenName

string

Optional

Card holder's mother Maiden Name. Valid ValuesA-Z, 0-9 Format:XXXX Example:Theresa

Allowable Values:

50

IDTypeCode

integer

Conditional

Government issued identification Type.Id Type Code should be passed in the request and not the description. Valid Values: 02- Driver’s license # 03- Matricular # 04- Passport 05- Visa 06- Green Card 07- State ID 08- Military ID 09- Voters Registration Card 10- government ID 11- Tax identification number Example:05 Condition: Required only when SecondaryCardType = 0(Regular Secondary Card)

IDIssueDate

datetime

Conditional

Issue date of ID card. Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2020 Condition: Required only when SecondaryCardType = 0 (Regular Secondary Card)

IDExpirationDate

datetime

Conditional

Government issued identification expiration date. Valid Values:MM/DD/YYYY Example:02/01/2020 Condition:Required only when SecondaryCardType = 0 (Regular Secondary Card)

IDCountry

string

Conditional

Country of Identification proof. Valid Values:a-z, 0-9 Example: Canada Condition: Required only when SecondaryCardType = 0 (Regular Secondary Card)

Allowable Values:

50

IDIssueState

string

Conditional

State of Identification proof Valid Values:a-z, 0-9 Example: AL Condition: Required only when SecondaryCardType = 0 (Regular Secondary Card)

Allowable Values:

50

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Example:John J Condition:If not given then First Name + Last Name will be printed

Allowable Values:

50

EmbossingLine4

string

Optional

Embossing line4.

Allowable Values:

20

HoldEmbossing

integer

Optional

Hold Embossing indicator Valid Values:1= YES, 0 = NO Format: X Example: 1

CardImageID

string

Optional

This is the card image type number which is already decided for embossing them. Valid Values:0-9 Format:XX Example:12

Allowable Values:

50

NameOnTrack

string

Optional

Name on Track echo in embossing file.

Allowable Values:

26

ActivationCode

string

Optional

Code which is provided at the time of Account Creation/Registration should be pass as a user validation.

Allowable Values:

50

ClientID

string

Optional

Indicate Client Id and echo in embossing file Valid Values: 1422245 Format:XXXXX Example: 5558547

Allowable Values:

50

VirtualCardExpOption

string

Conditional

Virtual card expiration option. Valid Values: 0 = Card expire after no.of transactions. 1 = Card expire on particular duration. 2 = Card expire on particular date. 3 = Card expiry date is same as Primary Card. Condition: This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 1

Allowable Values:

50

VirtualCardExpAfterTxn

integer

Conditional

Virtual card expiration option after certain number of transaction. Condition: This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 0

VirtualCardExpDate

datetime

Conditional

Virtual card expiration option at exact date. Valid Values: 0-9 Format: MM/DD/YYYY Example: 01/01/2024 Condition: This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 2

VirtualCardExpDuration

string

Conditional

Virtual card expiration duration like hour, minute, day etc Valid Values: 0 = Minutes 1 = Hour 2 = Day 3 = Week 4 = Month 5 = Year Condition: This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 1

Allowable Values:

50

VirtualCardExpDurationValue

integer

Conditional

Virtual card expiration Duration Value. Valid Values:0-9 Format:XXX Example:Virtual Card Expiry duration is 4(month) then this field value can be of 1-12. Condition:This field is mandatory when Secondary Card Type is '1'(Virtual) and VirtualCardExpOption = 1

VirtualCardLimit

decimal

Optional

Card limit of Virtual card. It can be 0 or Null. If it is 0 or Null then card will use Account's Credit Limit. Valid Values: 0-9 Format: XXXX.XX Example: 1000.00

VirtualCardResetAllow

integer

Conditional

Flag to allow or not allow reset on Virtual card. Valid Values:0 = Yes, 1 = No Example:0 Condition: This field is mandatory when Secondary Card Type is '1'(Virtual).

QRCode

string

Optional

This tag is to capture the QR code image file URL. Valid Values: 0-9,a-z Format: https/abc.com Example: https/abc.com

Allowable Values:

100

SignatureID

string

Optional

This tag is to capture the user signature image file in URL. Valid Values: 0-9,a-z Format: https/abc.com Example: https/abc.com

Allowable Values:

100

DeliveryMechanism

string

Optional

Shipment delivery mechanism.By Default Setting must be for standard Delivery and Usually overnight delivery involves card fee in credit environment. Valid Values: 0-Standard 1-Priority 2-Overnight Example:0

Allowable Values:

5

SharedCreditLimit

integer

Optional

This tag defines whether the same credit limit of the Primary borrower will be shared with the Secondary card or a different limit. Valid Values: 0-No,1-Yes Example:1 Condition: If no value sent in this tag, then system should by default consider the value as "Yes". If "Yes" is selected, then Secondary Card holder will have same credit limit as Primary Applicant.

SecondaryCardUsageLimit

decimal

Conditional

The usage limit defined for the secondary card. This limit is shared limit with the Primary Card. Valid Values: 0-9 Example:1000 Condition: If SharedCreditLimit is set as 'No' then this field is mandatory. If amount entered in this field is greater than Primary Borrower’s Credit limit, or less than set amount on the product, then an error message to be triggered.

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "700000000785214",
  "AdminNumber": 100989,
  "SecondaryCardType": "0",
  "Title": null,
  "FirstName": "John",
  "MiddleName": "K",
  "LastName": "Peter",
  "SurnameSuffix": null,
  "DateOfBirth": "04/04/1990 00:00:00",
  "AddressLine1": "address1",
  "AddressLine2": null,
  "City": "bhopal",
  "Country": "US",
  "PostalCode": "12345",
  "State": "AL",
  "ShippingAddressFlag": null,
  "HomePhoneNumber": "7684534354",
  "WorkPhoneNumber": null,
  "MobilePhoneNumber": null,
  "MobileCarrier": null,
  "LanguageIndicator": null,
  "EmailID": null,
  "SSN": "147852369",
  "IDNumber": null,
  "MotherMaidenName": null,
  "IDTypeCode": null,
  "IDIssueDate": null,
  "IDExpirationDate": null,
  "IDCountry": null,
  "IDIssueState": null,
  "NameOnCard": null,
  "EmbossingLine4": null,
  "HoldEmbossing": 0,
  "CardImageID": null,
  "NameOnTrack": null,
  "ActivationCode": null,
  "ClientID": null,
  "VirtualCardExpOption": null,
  "VirtualCardExpAfterTxn": null,
  "VirtualCardExpDate": null,
  "VirtualCardExpDuration": null,
  "VirtualCardExpDurationValue": null,
  "VirtualCardLimit": null,
  "VirtualCardResetAllow": null,
  "QRCode": null,
  "SignatureID": null,
  "DeliveryMechanism": null,
  "SharedCreditLimit": null,
  "SecondaryCardUsageLimit": null
}
Response fields detail
Fields Description

CardNumber

string

Card Number of account holder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874

Allowable Values:

19

AccountNumber

string

Account number of Card holder under which secondary card created. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:8000000000000037

Allowable Values:

19

AdminNumber

int64

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXX Example:12345

SecondaryCardType

string

Type of secondary card Valid Values: 0 -Regular Secondary Card, 1-Virtual Card Example: 0

Allowable Values:

25

CardStatus

string

Status of the requested card Example: New Card Pending Activation, Cancelled etc

Allowable Values:

25

FirstName

string

Card holder's First name. Example:John

Allowable Values:

40

LastName

string

Card holder's last name. Example:Smith

Allowable Values:

40

NameOnCard

string

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J

Allowable Values:

50

PrimaryExpiryDate

datetime

Expiry date of primary card under which secondary card is being created. Valid Values:0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

ValidFrom

datetime

Card Creation Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2020

ValidTo

datetime

Card Expiration Date of requested card. Format:MM/dd/yyyy HH:mm:ss Example:01/01/2022

CVC

string

3 Digit security number printed on back side of the card. Valid Values: 0-9 Format: XXX Example: 456

Allowable Values:

3

CardExpirationDate

datetime

Card Expiration Date of requested card. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

CloseDate

datetime

Card close or cancelation Date of requested card. Format: MM/dd/yyyy HH:mm:ss Example: 01/01/2020

CurrentCardBalance

decimal

Available Balance of Card. Valid Values:0-9 Format:XXX.XX Example:2000.00

ActivationRequired

boolean

Flag to identify whether activation is required or not.

CustomerID

string

Unique ID associated with Customer. Valid Values: 0-9 a-z Example:12345

Allowable Values:

25

Sample response body 

{
  "application/json": {
    "Message": "Card created successfully.",
    "Status": true,
    "ErrorCode": "ERR01070",
    "ResponseData": {
      "CardNumber": "XXXXXXXXXXXXXXX",
      "AccountNumber": "45444832544444",
      "AdminNumber": 6467487544,
      "SecondaryCardType": "0",
      "CardStatus": "New Card Pending Activation",
      "FirstName": "John",
      "LastName": "Miller",
      "NameOnCard": "John Miller",
      "PrimaryExpiryDate": "11/02/2022 00:00:00",
      "ValidFrom": "11/02/2020 00:00:00",
      "ValidTo": "11/02/2022 00:00:00",
      "CVC": "XXX",
      "CardExpirationDate": "11/02/2020 00:00:00",
      "CloseDate": "11/02/2020 00:00:00",
      "CurrentCardBalance": 1050.0,
      "ActivationRequired": true,
      "CustomerID": null
    }
  }
}

Request Stock

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/RequestStock

POST /api/CoreCredit/AccountHolders/RequestStock

Use this API to create accounts in bulk in the CoreCard system to create an inventory of the cards. New accounts may be created under a specific product or partner (StoreID).

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language == en: means use English ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

InstitutionID

integer

Mandatory

Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

ProductID

integer

Mandatory

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

MerchantID

integer

Optional

Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345

StoreID

string

Mandatory

ID of the Store Valid Values: 0-9 Example:1234 Condition:Core Card will provide the value for this field after the Program is setup.

HoldEmbossing

string

Mandatory

Hold embossing indicator. Valid Values: 1= YES, 0 = NO

Allowable Values:

2

DeliveryMechanism

string

Optional

Delivery Mechanism(Overnight, Priority or Standard). Valid Values: 0 -for Standard ,1 -for Priority , 2 -for Overnight Condition: Delivery mechanism is optional.

Allowable Values:

5

NumberofCard

integer

Mandatory

Embossing quantity for request made. Valid Values:0-9 Format:XX Example:02

Title

string

Optional

Title of Person to whom stock is shipped. Format: A-Z Example:Mr

Allowable Values:

10

FirstName

string

Optional

First name of Person to whom stock is shipped. Valid Values:A-Z Example:User1

Allowable Values:

50

MiddleName

string

Optional

Middle Name of Person to whom stock is shipped. Valid Values: A-Z Example: LEE

Allowable Values:

50

LastName

string

Optional

Last name of Person to whom stock is shipped. Valid Values:A-Z Example:Smith

Allowable Values:

50

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J

Allowable Values:

50

EmbossingLine4

string

Optional

Embossing line4

Allowable Values:

50

ShippingAddressLine1

string

Optional

Shipping address line 1 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

ShippingAddressLine2

string

Optional

Shipping address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue

Allowable Values:

50

ShippingCity

string

Optional

Shipping address city name. Example:Los Angeles

Allowable Values:

40

ShippingState

string

Optional

Sate of the shipping address. Example:Virginia

Allowable Values:

40

ShippingPostalCode

string

Optional

Zip code of the shipping address. Valid Values:0-9 Example:46206

Allowable Values:

9

ShippingCountry

string

Optional

Shipping address Country name Valid Values: 0-9, A-Z Format: XXXXXXXXXX Example: USA

Allowable Values:

3

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

InstitutionID

integer

Mandatory

Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

ProductID

integer

Mandatory

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

MerchantID

integer

Optional

Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345

StoreID

string

Mandatory

ID of the Store Valid Values: 0-9 Example:1234 Condition:Core Card will provide the value for this field after the Program is setup.

HoldEmbossing

string

Mandatory

Hold embossing indicator. Valid Values: 1= YES, 0 = NO

Allowable Values:

2

DeliveryMechanism

string

Optional

Delivery Mechanism(Overnight, Priority or Standard). Valid Values: 0 -for Standard ,1 -for Priority , 2 -for Overnight Condition: Delivery mechanism is optional.

Allowable Values:

5

NumberofCard

integer

Mandatory

Embossing quantity for request made. Valid Values:0-9 Format:XX Example:02

Title

string

Optional

Title of Person to whom stock is shipped. Format: A-Z Example: Refer Appendix Section 5.7

Allowable Values:

5

FirstName

string

Optional

First name of Person to whom stock is shipped. Valid Values:A-Z Example:User1

Allowable Values:

40

MiddleName

string

Optional

Middle Name of Person to whom stock is shipped. Valid Values: A-Z Example: LEE

Allowable Values:

10

LastName

string

Optional

Last name of Person to whom stock is shipped. Valid Values:A-Z Example:Smith

Allowable Values:

40

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J

Allowable Values:

50

EmbossingLine4

string

Optional

Place holder on Embossing. Valid Values:A-Z, 0-9 Format:XXXX Example: Embossing Info

Allowable Values:

20

ShippingAddressLine1

string

Optional

Shipping address line 1 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

ShippingAddressLine2

string

Optional

Shipping address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue

Allowable Values:

50

ShippingCity

string

Optional

Shipping address city name. Example:Los Angeles

Allowable Values:

40

ShippingState

string

Optional

Sate of the shipping address. Example:Virginia

Allowable Values:

40

ShippingPostalCode

string

Optional

Zip code of the shipping address. Valid Values:0-9 Example:46206

Allowable Values:

9

ShippingCountry

string

Optional

Shipping address Country name Valid Values: 0-9, A-Z Format: XXXXXXXXXX Example: USA

Allowable Values:

3
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "InstitutionID": 1320,
  "ProductID": null,
  "MerchantID": 7010,
  "StoreID": "7020",
  "HoldEmbossing": "1",
  "DeliveryMechanism": "0",
  "NumberofCard": 10,
  "Title": null,
  "FirstName": null,
  "MiddleName": null,
  "LastName": null,
  "NameOnCard": null,
  "EmbossingLine4": null,
  "ShippingAddressLine1": null,
  "ShippingAddressLine2": null,
  "ShippingCity": null,
  "ShippingState": null,
  "ShippingPostalCode": null,
  "ShippingCountry": null
}
Response fields detail
Fields Description

OrderID

integer

Order ID Valid Values:0-9 Format:XXXX

RequestID

integer

Request ID Valid Values:0-9 Format:XXXX

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Valid Values:0-9,a-z

Allowable Values:

15

RecordType

integer

Record Type

ProductType

integer

Product Type Valid Values:0-9 Format:XXXX

FirstName

string

Card holder's First name. Valid Values:A-Z Example:User1

Allowable Values:

50

MiddleName

string

Card holder's Middle Name. Valid Values: A-Z Example: LEE

Allowable Values:

50

LastName

string

Card holder's last name. Valid Values:A-Z Example:Smith

Allowable Values:

50

AccountNumber

string

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

CustomerID

string

Customer ID of Cardholder assigned to a Program Valid Values:0-9 Format:XXXX

AccountCreationDate

datetime

Account Creation Date

AccountCreationTime

datetime

Time of Account Creation

TerminalID

string

TerminalID

Allowable Values:

50

EmailID

string

Card holder Email ID Valid Values:0-9 Format:XXX@xx.com Example:ABC@gmail.com

Allowable Values:

300

ManualStatus

string

Status of account assigned manually Valid Values: Active, Closed etc. Format:XXXX Example:Active

Allowable Values:

15

GeneratedStatus

string

Generated status based on Account Status, Card Manual Status and Embossing Status. Valid Values:Possible values - Active,Blocked etc Format:XXXX Example:Possible values - Active,Blocked etc

Allowable Values:

250

UniversalUniqueID

string

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

Allowable Values:

64

BulkCardUUID

string

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

Allowable Values:

64

OrderID

integer

Order ID Valid Values:0-9 Format:XXXX

RequestID

integer

Request ID Valid Values:0-9 Format:XXXX

ResponseID

string

This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking. Valid Values:0-9,a-z

Allowable Values:

15

MiddleName

string

Card holder's Middle Name. Valid Values: A-Z Example: LEE

Allowable Values:

10

Sample response body 

{
  "application/json": {
    "Message": "Order request created successfully",
    "Status": true,
    "ErrorCode": "ERR01121",
    "ResponseData": {
      "OrderID": 1002,
      "RequestID": 1002,
      "ResponseID": "56806634",
      "MiddleName": null
    }
  }
}

Decision On Bulk Card Request

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/ApproveOrDeclineBulkCardRequest

POST /api/CoreCredit/AccountHolders/ApproveOrDeclineBulkCardRequest

Use this API to approve or decline a bulk card (inventory card) request created in the CoreCARD system via the bulk card unique ID or Order ID. If a bulk card request is approved, it is forwarded to the embosser vendor for printing. Rejected requests are marked as "VOID" in the CoreCARD system.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

OrderID

integer

Conditional

Order ID of the Bulk card order Valid Values:0-9 Format:XXXXX Example:12345 Condition:Either of one identifier is mandatory from: OrderID BulkCardUUID

BulkCardUUID

string

Conditional

Unique number Bulk card order Valid Values:0-9 Format:XXXXX Example:12345 Condition:Either of one identifier is mandatory from: OrderID BulkCardUUID

BulkAction

boolean

Mandatory

Action for the bulk request i.e Approve or decline Valid Values:True(Approve) False(Decline) Format:XXXXX Example:True

Sample request body 
{
  "Source": "web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "OrderID": 1002,
  "BulkCardUUID": null,
  "BulkAction": null
}
Response fields detail
Fields Description

ResponseID

string

This number indicates that API responded.Response ID is unique.This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200

Allowable Values:

15

Sample response body 

{
  "application/json": {
    "Message": "Card Creation Approved.",
    "Status": true,
    "ErrorCode": "ERR01123",
    "ResponseData": {
      "ResponseID": "64345"
    }
  }
}

View Bulk Card Details

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/ViewBulkCardDetails

POST /api/CoreCredit/AccountHolders/ViewBulkCardDetails

The BulkcardUUID or Order ID  can be used to retrieve details of the bulk card order once an order has been created in the CoreCARD system. This API returns details that may include DeliveryMechanism AddressLine1, CreateDate, ApprovedBy, and NumberOfCard.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

MerchantID

integer

Conditional

Unique number of merchant account. Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: Either of one identifier is mandatory from: MerchantID, OrderID, BulkCardUUID, ProductID, StoreID

OrderID

integer

Conditional

Order ID of the Bulk card order Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: Either of one identifier is mandatory from: MerchantID, OrderID, BulkCardUUID, ProductID, StoreID

BulkCardUUID

string

Conditional

Unique number Bulk card order Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: Either of one identifier is mandatory from: MerchantID, OrderID, BulkCardUUID, ProductID, StoreID

Allowable Values:

64

ProductID

integer

Conditional

ID assigned to a Program Valid Values: 0-9 Format: XXXX Example: Fixed value provided by CoreCard. Condition: Either of one identifier is mandatory from: MerchantID, OrderID, BulkCardUUID, ProductID, StoreID

StoreID

integer

Conditional

Store ID Valid Values: XXX Format: 0-9 Example: 1234 Condition: Either of one identifier is mandatory from: MerchantID, OrderID, BulkCardUUID, ProductID, StoreID

CardNumber

string

Optional

Card Number of account holder Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896541236

Allowable Values:

19

AccountNumber

string

Optional

Debtor File # or Client Account # Valid Values: 0-9 Format: XXXXXXXXXX Example: 7314145404 Condition: At least one account identifier is required.

Allowable Values:

19

DeliveryMechanism

string

Optional

Shipment delivery mechanism. By Default Setting must be for standard Delivery Valid Values: a-z Format: xxxx Example: (Overnight, Priority or Standard)

Allowable Values:

50

OderStatus

string

Optional

It has values as Approval pending, Approved, Cards Created, Rejected. Valid Values: A-Z Format: XXXXXXXXX Example: Approval pending

Allowable Values:

50
Sample request body 
{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "MerchantID": null,
  "OrderID": 1001,
  "BulkCardUUID": null,
  "ProductID": null,
  "StoreID": null,
  "CardNumber": null,
  "AccountNumber": null,
  "DeliveryMechanism": null,
  "OderStatus": null
}
Response fields detail
Fields Description

BulkRequestDetails

array

List of the following Bulk card tags

ResponseID

int64

This number indicates that API responded.Response ID is unique.This value will be null if no authentication information was passed.Response ID can be used for tracking Valid Values: 0-9,a-z Format: xxx Example: 200

CurrencySymbol

string

This tag reflects the currency symbol

BulkRequestDetails

array

List of the following Bulk card tags

ResponseID

int64

This number indicates that API responded.Response ID is unique.This value will be null if no authentication information was passed.Response ID can be used for tracking Valid Values: 0-9,a-z Format: xxx Example: 200

CurrencySymbol

string

This tag reflects the currency symbol

Sample response body 

{
  "application/json": {
    "Message": "Search Successful",
    "Status": true,
    "ErrorCode": "ERR01124",
    "ResponseData": {
      "BulkRequestDetails": [
        {
          "OrderID": 1001,
          "RequestID": 1001,
          "MerchantID": "0",
          "RequestDate": null,
          "NumberOFCard": 50,
          "Status": "Approved",
          "CreateDate": null,
          "AddressLine1": "A3",
          "AddressLine2": "Canal Kinship",
          "City": "Indore",
          "PostalCode": "46502",
          "Country": "US",
          "State": "AL",
          "ProductID": "0",
          "StoreName": "7020=ABC_Store",
          "Title": "01",
          "FirstName": "Aditya",
          "MiddleName": "",
          "LastName": "Arya",
          "NameOnCard": "Abhishek",
          "ApprovedBy": "",
          "EmbossingLine4": "Aditya Abhishek Arya",
          "InstitutionID": 1320,
          "DeliveryMechanism": "0"
        }
      ],
      "ResponseID": 56816607
    }
  }
}

Update Stock Request

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/UpdateStockRequest

POST /api/CoreCredit/AccountHolders/UpdateStockRequest

Use this API to update details of an existing stock request by providing an order ID. Name and shipping details and the name on a card attributes can be updated on an existing stock card order.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

OrderID

integer

Conditional

Order ID of the Bulk card order. Valid Values:0-9 Example: 12345 Condition:Either of one identifier is mandatory from:OrderID, BulkCardUUID

BulkCardUUID

string

Conditional

Unique number Bulk card order Valid Values:0-9 Example: 12345 Condition:Either of one identifier is mandatory from:OrderID, BulkCardUUID

Allowable Values:

64

ShippingAddressLine1

string

Optional

Shipping address line 1. Valid Values:A-Z, 0-9 Example:2354 Main road

Allowable Values:

50

ShippingAddressLine2

string

Optional

Shipping address line 2 Valid Values: A-Z, 0-9 Example:xyz Avenue

Allowable Values:

50

ShippingCity

string

Optional

Shipping address city name. Example:Los Angeles

Allowable Values:

40

ShippingPostalCode

string

Optional

Zip code of the shipping address. Valid Values:0-9 Format:XXXXX Example:46206

Allowable Values:

10

ShippingCountry

string

Optional

Shipping address Country name. Example:US

Allowable Values:

5

ShippingState

string

Optional

State of the shipping address. Format:XXXXX Example: AL

Allowable Values:

5

Title

string

Optional

Title of Person to whom stock is shipped. Example:Mr

Allowable Values:

5

FirstName

string

Optional

First name of Person to whom stock is shipped. Example:User1

Allowable Values:

40

MiddleName

string

Optional

Middle Name of Person to whom stock is shipped. Example: LEE

Allowable Values:

10

LastName

string

Optional

Last name of Person to whom stock is shipped. Example: Smith

Allowable Values:

40

NameOnCard

string

Optional

Name to be printed on the card. Valid Values:A-Z, 0-9 Example:John J Condition:If not given then First Name + Last Name will be printed

Allowable Values:

50

EmbossingLine4

string

Optional

Embossing line4.

Allowable Values:

20

HoldEmbossing

integer

Optional

Hold Embossing indicator Valid Values:1= YES, 0 = NO Format: X Example: 1

DeliveryMechanism

integer

Optional

Shipment delivery mechanism.By Default Setting must be for standard Delivery Valid Values: Standard = 0, Priority = 1, Overnight = 2 Example:0

NumberOFCard

integer

Optional

Embossing quantity for request made. Valid Values:0-9 Example:10

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "OrderID": 4015,
  "BulkCardUUID": null,
  "ShippingAddressLine1": null,
  "ShippingAddressLine2": null,
  "ShippingCity": null,
  "ShippingPostalCode": null,
  "ShippingCountry": null,
  "ShippingState": null,
  "Title": null,
  "FirstName": "John",
  "MiddleName": null,
  "LastName": "Smith",
  "NameOnCard": null,
  "EmbossingLine4": null,
  "HoldEmbossing": null,
  "DeliveryMechanism": null,
  "NumberOFCard": null
}
Response fields detail
Fields Description

ResponseID

string

This number indicates that API responded. Response ID is unique.

Sample response body 

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "ResponseID": "108410544"
    }
  }
}

Get Co-signer Details

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/GetCosignerDetails

POST /api/CoreCredit/AccountHolders/GetCosignerDetails

Use this API to retrieve co-signer data such as PII (personal identification information), contact information, demographic details, and the bankruptcy notification date and indicator (if any).

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountID

string

Mandatory

Description:Account ID represents Unique Identity of Account Format:XXXXX Example:12345

Allowable Values:

25
Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountID": "167573"
}
Response fields detail
Fields Description

CustomerID

string

Description:Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123

Allowable Values:

25

CosignerTitle

string

Description: Cosigner's Title like MR or MRS. Valid Values:Refer Appendix section 5.7 Format: xx Example: 01 = MR, 16 = Col, 17 = Judge

Allowable Values:

15

CosignerFirstName

string

Description: Cosigner's First Name Valid Values:A-Z,0-9 Format:XXXXX Example:User1

Allowable Values:

50

CosignerMiddleName

string

Description: Cosigner's Middle Name Valid Values:A-Z,0-9 Format:XXXXX Example:User1

Allowable Values:

50

CosignerLastName

string

Description: Cosigner's Last Name Valid Values:A-Z,0-9 Format:XXXXX Example:User1

Allowable Values:

50

CosignerAddress1

string

Cosigner's Address Line 1

Allowable Values:

50

CosignerAddress2

string

Cosigner's Address Line 2

Allowable Values:

50

CosignerCity

string

Cosigner's City.

Allowable Values:

25

CosignerState

string

Description: Cosigner’s State Valid Values:A-Z,0-9 Format:XXXXX Example:abcd

Allowable Values:

25

CosignerCountry

string

Description: Cosigner’s Country Valid Values:A-Z,0-9 Format:XXXXX Example:abcd

Allowable Values:

15

CosignerPostalCode

string

Description: Cosigner’s Postal code Valid Values:0-9 Format:XXXXX Example:99501

Allowable Values:

9

CosignerHomePhoneNumber

string

Description: Cosigner's Home Phone Number Valid Values:0-9 Format:XXXXXXXXX Example:7548264758

Allowable Values:

11

CosignerWorkPhoneNumber

string

Description: Cosigner's work phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412

Allowable Values:

11

CosignerMobileNumber

string

Description: Cosigner's Mobile phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412

Allowable Values:

11

CosignerOtherPhoneNumber

string

Description: Cosigner's Other phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412

Allowable Values:

11

CosignerFaxNumber

string

Description: Cosigner's Fax number Valid Values:0-9 Format:XXXXXXXXX Example:784565412

Allowable Values:

11

CosignerCreditFilePhone

string

Cosigner's Credit File Phone number.

Allowable Values:

11

CosignerAlternatePhone

string

Description: Cosigner's Alternate phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412

Allowable Values:

11

CosignerEmailID

string

Description: Cosigner's email ID associated with additional address details Valid Values: 0-9 a-z Format:xxx@xxx.xxx Example:abc@xyz.com

Allowable Values:

30

CosignerDateofBirth

datetime

Description: Cosigner’s Date of Birth Valid Values: Format:MM/DD/YYYY Example:01/02/1988

CosignerResidenceType

string

Description: Cosigner residence type Valid Values: Refer Appendix section 5.15 Format: xxxx Example: Own

Allowable Values:

10

CosignerBadAddress

integer

Description: Identifies the Cosigner's provided address is a bad address. Valid Values:0 or 1 Format: x Example: 1

CosignerMaritalStatus

string

Description: Cosigner's Marital Status Valid Values: 0,1 Format: x Example: 0- No, 1 - Yes

Allowable Values:

1

CosignerSSN

string

Description: Cosigner’s Social Security Number Valid Values:0-9 Format:XXXXXXXXX Example:XXXXX8796

Allowable Values:

12

CosignerGender

string

Description: Gender of Cosigner Valid Values: A-Z Format: xxxxxxx Example: Male

Allowable Values:

5

CosignerCeaseAndDesist

integer

Description: This tag reflects whenever Cosigner is ceased or desist the CoreCOLLECT user need not follow up the mapped account holder thus all the credentials of the mapped account holders are erased from the dialer file using this flag. Valid Values: 0 or 1 Format: x Example: 1

Allowable Values:

1

CeaseAndDesistCommunication

string

Values: All Communication Litigation Phone and Email Phone and Mail Email and Mail Phone Only Email Only Mail Only ATTO

Allowable Values:

20

CosignerBankruptcy

integer

Description: Cosigner's Flag for Bankruptcy Valid Values: 0,1 Format: x Example: 0-no, 1-yes

Allowable Values:

1

CosignerBankruptcyNotificationDate

datetime

Description: Cosigner's bankruptcy notification date. Valid Values: 0-9 Format:MM/DD/YYYY HH:MM:SS Example:12/20/2019 12:18:19

CosignerDeceased

integer

Flag to mark deceased.

CosignerDeceasedNotificationDate

datetime

Description: Date when deceased is notified Format:MM/DD/YYYY Example:02/20/2020 Condition: Mandatory for deceased account

HomePhoneNumberTechType

integer

Description: Tech Type of Home Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

MobileNumberTechType

integer

Description: Tech Type of Mobile Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

WorkPhoneNumberTechType

integer

Description: Tech Type of Work Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

OtherPhoneNumberTechType

integer

Description: Tech Type of other Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

FaxNumberTechType

integer

Description: Tech Type of Fax Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CreditFilePhoneTechType

integer

Description: Tech Type of Credit File Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

AlternatePhoneTechType

integer

Description: Tech Type of Alternate Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CosignerConsumerInformationIndicator

string

CosignerConsumerInformationIndicator

Allowable Values:

15

CosignerFraudVictim

boolean

Description: Identifies the Cosigner as Fraud victim. Valid Values:0 or 1 Format: x Example: 1

CosignerAddressLine1

string

Description: Cosigner's Address line1 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

CosignerAddressLine2

string

Description: Cosigner's Address line2 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

CosignerCeaseDesistCommunication

string

Description: Cosigner's Cease and Desist communication Valid Values: Available in Appendix section 5.37 Format: xxxxxx Example: litigation, Phone and Mail etc

Allowable Values:

20

CosignerMobileCarrier

string

This tag reflect the co-signer Mobile carrier company Valid Values:A-z, 0-9 Format:XXXXXXXX Example:Vodafone

Allowable Values:

25

CosignerStatus

string

Description:Status of Cosigner Valid Values: 0-1 Format: 0 Example: 1

Allowable Values:

1

Sample response body 

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "CustomerID": "167383",
      "CosignerTitle": null,
      "CosignerFirstName": "Bhushan",
      "CosignerMiddleName": null,
      "CosignerLastName": "Waje",
      "CosignerAddressLine1": "ISC Software Private Limited",
      "CosignerAddressLine2": "kush",
      "CosignerCity": "Navi Mumbai",
      "CosignerState": "AS",
      "CosignerCountry": "US",
      "CosignerPostalCode": "400614",
      "CosignerHomePhoneNumber": "5698756891",
      "CosignerWorkPhoneNumber": "5871458796",
      "CosignerMobileNumber": "5698758795",
      "CosignerOtherPhoneNumber": null,
      "CosignerFaxNumber": null,
      "CosignerCreditFilePhone": null,
      "CosignerAlternatePhone": null,
      "CosignerEmailID": "bhushan.waje@corecard.com",
      "CosignerDateofBirth": "08/03/1993 00:00:00",
      "CosignerResidenceType": "O",
      "CosignerBadAddress": 0,
      "CosignerMaritalStatus": null,
      "CosignerSSN": null,
      "CosignerGender": null,
      "CosignerCeaseAndDesist": 0,
      "CosignerCeaseDesistCommunication": null,
      "CosignerBankruptcy": 0,
      "CosignerBankruptcyNotificationDate": null,
      "CosignerDeceased": 0,
      "CosignerDeceasedNotificationDate": null,
      "CosignerMobileCarrier": null,
      "HomePhoneNumberTechType": null,
      "MobileNumberTechType": null,
      "WorkPhoneNumberTechType": null,
      "OtherPhoneNumberTechType": null,
      "FaxNumberTechType": null,
      "CreditFilePhoneTechType": null,
      "AlternatePhoneTechType": null,
      "CosignerConsumerInformationIndicator": null,
      "CosignerFraudVictim": false,
      "CosignerStatus": "1"
    }
  }
}

Update Co-signer Details

Action: POST

Endpoint: /api/CoreCredit/AccountHolders/UpdateCosignerDetails

POST /api/CoreCredit/AccountHolders/UpdateCosignerDetails

Use this API to update co-signer data such as PII (personal identification information), contact information, demographic details, and the bankruptcy notification date and indicator (if any). 

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:At least one of AdminNumber/AccountNumber/CustomerID is required.

AccountNumber

string

Conditional

Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/AccountNumber/CustomerID is required.

Allowable Values:

19

CustomerID

string

Conditional

Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 Condition:At least one of AdminNumber/AccountNumber/CustomerID is required.

Allowable Values:

25

CosignerTitle

string

Optional

Cosigner's Title like MR or MRS. Valid Values:Refer Appendix section 5.7 Format: xx Example: 01 = MR, 16 = Col, 17 = Judge

Allowable Values:

10

CosignerFirstName

string

Optional

Cosigner's First Name valid Values:A-Z,0-9 Example:User1

Allowable Values:

50

CosignerMiddleName

string

Optional

Cosigner's Middle Name valid Values:A-Z,0-9 Example:User1

Allowable Values:

50

CosignerLastName

string

Optional

Cosigner's Last Name valid Values:A-Z,0-9 Example:User1

Allowable Values:

50

CosignerAddressLine1

string

Optional

Cosigner's Address Line 1 valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

CosignerAddressLine2

string

Optional

Cosigner's Address Line 2 valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

CosignerCity

string

Optional

Cosigner's City valid Values:A-Z,0-9 Format:XXXXX Example:Chicago

Allowable Values:

20

CosignerState

string

Optional

Cosigner's State valid Values:A-Z,0-9 Format:XXXXX Example:abcd

Allowable Values:

50

CosignerPostalCode

string

Optional

Cosigner's Postal Code valid Values:0-9 Format:XXXXX Example:99501

Allowable Values:

50

CosignerCountry

string

Optional

Cosigner's Country Valid Values:A-Z,0-9 Format:XXXXX Example:abcd Example:US

Allowable Values:

50

CosignerEmailID

string

Optional

Cosigner's Email ID Valid Values: 0-9 a-z Format:xxx@xxx.xxx Example:abc@xyz.com

Allowable Values:

50

CosignerHomePhoneNumber

string

Optional

Cosigner's Home Phone Number valid Values:0-9 Format:XXXXXXXXXX Example:9974865836

Allowable Values:

15

CosignerWorkPhoneNumber

string

Optional

Cosigner's Work Phone Number valid Values:0-9 Format:XXXXXXXXXX Example:9758356383

Allowable Values:

15

CosignerMobilePhoneNumber

string

Optional

Cosigner's Mobile Phone Number. valid Values:0-9 Format:XXXXXXXXXX Example:784565412

Allowable Values:

11

CosignerOtherPhoneNumber

string

Optional

Cosigner's Other Phone Number. valid Values:0-9 Format:XXXXXXXXXX Example:784565412

Allowable Values:

11

CosignerFaxNumber

string

Optional

Cosigner's Fax number. valid Values:0-9 Format:XXXXXXXXXX Example:784565412

Allowable Values:

11

CosignerCreditFilePhone

string

Optional

Cosigner's Credit File Phone Number. valid Values:0-9 Format:XXXXXXXXXX Example:784565412

Allowable Values:

11

CosignerAlternatePhoneNumber

string

Optional

Cosigner's Alternate Phone Number valid Values:0-9 Example:9738758349

Allowable Values:

15

CosignerMobileCarrier

string

Optional

Cosigner's Mobile carrier company Valid Values:A-z, 0-9 Format:XXXXXXXX Example: c.vodafone.ne.jp, csouth1.com, m1.com.sg

Allowable Values:

50

CosignerDateOfBirth

DateTime

Optional

Cosigner's date of birth valid Values:0-9 Format: MM/dd/YYYY Example:11/23/1980

CosignerResidenceType

string

Optional

Cosigner residence type Valid Values: Refer Appendix section 5.15 Format: xxxx Example: Own

Allowable Values:

25

CosignerDurationatAddress

string

Optional

Identifies the Cosigner's provided address is a bad address. Valid Values: 0-9 Format: xxx Example: 12

Allowable Values:

4

CosignerBadAddress

integer

Optional

Identifies the Cosigner's provided address is a bad address. Valid Values:0 or 1 Format: x Example: 1

CosignerMaritalStatus

integer

Optional

Cosigner's Marital Status Valid Values: 0,1 Format: x Example: 0- No, 1 - Yes

CosignerSSN

int64

Optional

Cosigner's Social Security Number Valid Values:0-9 Format:XXXXXXXXX Example:987456321

CosignerGender

string

Optional

Gender of Cosigner. Valid Values: 0 - No information available 1 -Male 2-Female Format:X Example:1

Allowable Values:

5

CosignerCeaseandDesist

integer

Optional

This tag reflects whenever Cosigner is ceased or desist the CoreCOLLECT user need not follow up the mapped account holder thus all the credentials of the mapped account holders are erased from the dialer file using this flag. Valid Values:0 or 1 Format:X Example:1

CeaseDesistCommunication

integer

Conditional

Cosigner's Cease and Desist communication Valid Values: Available in Appendix section 5.36 Format: xxxxxx Example: litigation, Phone and Mail etc

CosignerBankruptcy

integer

Optional

Cosigner's Flag for Bankruptcy Valid Values: 0,1 Format: x Example: 0-no, 1-yes

CosignerBankruptcyNotificationDate

DateTime

Conditional

Cosigner's bankruptcy notification date. Valid Values: 0-9 Format:MM/DD/YYYY HH:MM:SS Example:12/20/2019 12:18:19 Condition: This field is mandatory when CosignerBankruptcy is checked.

CosignerDeceased

integer

Optional

This tag reflects whether the Cosigner is deceased or not . Valid Values: 0-9 Format: 0 or 1 Example: 0

CosignerDeceasedNotificationDate

DateTime

Conditional

Date when deceased is notified. Format:MM/DD/YYYY Example:02/20/2020 Condition:This field is mandatory when CosignerDeceased tag is checked.

CosignerEmploymentType

int64

Optional

Type of employement of Cosigner. Valid Values: Appendix section 5.35 Format: xxxxx Example: Accountant/Analyst/Architect

CosignerCombinedTotalIncome

decimal

Optional

Cosigner's Combined Total Income valid Values:0-9 Example:10000

CosignerMonthsOfEmployment

string

Optional

Cosigner's Number on months in current employment Valid Values:0-9 Format:XX Example:32

CosignerPosition

string

Optional

Employement position of the Cosigner. valid Values:A-Z,0-9 Example:Manager

Allowable Values:

50

CosignerEmployeeNumber

string

Optional

Cosigner's Employee Number Valid Values: 0-9 Format: XXXXXXXXXX Example: 7895463214

Allowable Values:

25

CosignerEmployerName

string

Optional

Cosigner's Employer Name. valid Values:A-Z,0-9 Example:john Condition:Report the name of the employer for the consumer reported in the Base Segment in CBR

Allowable Values:

50

CosignerEmployerAddressLine1

string

Optional

Cosigner's Employer Address Line 1 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

CosignerEmployerAddressLine2

string

Optional

Cosigner's Employer Address Line 2 Valid Values:A-Z, 0-9 Example:123 HWY

Allowable Values:

50

CosignerEmployerPostalCode

string

Optional

Cosigner's Employer PostalCode. valid Values:0-9 Format:xxxx Example:123456

Allowable Values:

9

CosignerEmployerPhoneNumber

string

Optional

Cosigner's Employer phone number Valid Values:0-9 Format:XXXXXXXXX Example:784565412

Allowable Values:

20

CosignerEmployerFaxNumber

string

Optional

Cosigner's Employer Fax number Valid Values:0-9 Format:XXXXXXXXXX Example:7895463214

Allowable Values:

10

CosignerEmployerCity

string

Optional

Cosigner's Employer City. valid Values:A-Z,0-9 Example:kansas

Allowable Values:

25

CosignerEmployerCountry

string

Optional

Cosigner's Employer Country. valid Values:A-Z,0-9 Example:US

Allowable Values:

25

CosignerEmployerState

string

Optional

Cosigner's Employer State. valid Values:A-Z,0-9 Example:CA

Allowable Values:

25

CosignerGovernmentIDType

string

Optional

Government issued identification Type.Government Id Type Code should be passed in the request and not the description. Valid Values:A-Z, 0-9 Format:XXXXXXX Example:CDDA97418Q

Allowable Values:

25

CosignerIDNumber

string

Optional

Cosigner's Government ID Number Valid Values:A-Z Format:XXXXXXXX Example::CDDT9741Q

Allowable Values:

20

CosignerIDIssueCountry

string

Optional

Cosigner's ID Issue Country valid Values:A-Z,a-z Example:US

Allowable Values:

20

CosignerIDIssueState

string

Optional

Cosigner's ID Issue State valid Values:A-Z,a-z Example:Alabama

Allowable Values:

20

CosignerIDIssueDate

DateTime

Optional

Cosigner’s Government ID Issue Date Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2020

CosignerIDExpirationDate

DateTime

Optional

Cosigner’s Government ID Expiry Date Format:MM/DD/YYYY Example:01/02/1988

CosignerHomePhoneNumberTechType

integer

Optional

Description: Tech Type of Home Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CosignerMobileNumberTechType

integer

Optional

Description: Tech Type of Mobile Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CosignerWorkPhoneNumberTechType

integer

Optional

Description: Tech Type of Work Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CosignerOtherPhoneNumberTechType

integer

Optional

Description: Tech Type of other Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CosignerFaxNumberTechType

integer

Optional

Description: Tech Type of Fax Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CosignerCreditFilePhoneTechType

integer

Optional

Description: Tech Type of Credit File Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CosignerAlternatePhoneTechType

integer

Optional

Description: Tech Type of Alternate Phone Number. Valid Values: 0 / 1 Format: x Example: 0 = Mobile, 1 = Landline Condition:I6129

CosignerFraudVictim

string

Description: Identifies the Cosigner as Fraud victim. Valid Values:0 or 1 Format: x Example: 1

Allowable Values:

2

CosignerStatus

string

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": "",
  "APIVersion": "2.0",
  "CallerID": "",
  "CalledID": "",
  "RequestTime": null,
  "AdminNumber": null,
  "AccountNumber": "8110000000000224",
  "CustomerID": "",
  "CosignerTitle": null,
  "CosignerFirstName": "Ravi",
  "CosignerMiddleName": null,
  "CosignerLastName": "Kumar",
  "CosignerAddressLine1": "hgyuergegik",
  "CosignerAddressLine2": "klkdhshkjb",
  "CosignerCity": "Sweden",
  "CosignerState": "AK",
  "CosignerPostalCode": "125433",
  "CosignerCountry": "US",
  "CosignerEmailID": "nbdftgy@gnb.com",
  "CosignerHomePhoneNumber": "3652140524",
  "CosignerWorkPhoneNumber": "7412547894",
  "CosignerMobilePhoneNumber": "3214589134",
  "CosignerOtherPhoneNumber": "258747251",
  "CosignerFaxNumber": "7896541204",
  "CosignerCreditFilePhone": "8524169674",
  "CosignerAlternatePhoneNumber": "1256417484",
  "CosignerMobileCarrier": "",
  "CosignerDateOfBirth": "11/02/1977",
  "CosignerResidenceType": "",
  "CosignerDurationatAddress": "",
  "CosignerBadAddress": null,
  "CosignerMaritalStatus": null,
  "CosignerSSN": null,
  "CosignerGender": null,
  "CosignerCeaseandDesist": null,
  "CeaseDesistCommunication": null,
  "CosignerBankruptcy": null,
  "CosignerBankruptcyNotificationDate": null,
  "CosignerDeceased": null,
  "CosignerDeceasedNotificationDate": null,
  "CosignerEmploymentType": null,
  "CosignerCombinedTotalIncome": null,
  "CosignerMonthsOfEmployment": "",
  "CosignerPosition": "",
  "CosignerEmployeeNumber": "",
  "CosignerEmployerName": "",
  "CosignerEmployerAddressLine1": "",
  "CosignerEmployerAddressLine2": "",
  "CosignerEmployerPostalCode": "",
  "CosignerEmployerPhoneNumber": "",
  "CosignerEmployerFaxNumber": "",
  "CosignerEmployerCity": "",
  "CosignerEmployerCountry": "",
  "CosignerEmployerState": "",
  "CosignerGovernmentIDType": "",
  "CosignerIDNumber": "",
  "CosignerIDIssueCountry": "",
  "CosignerIDIssueState": "",
  "CosignerIDIssueDate": "",
  "CosignerIDExpirationDate": "",
  "CosignerHomePhoneNumberTechType": null,
  "CosignerMobileNumberTechType": null,
  "CosignerWorkPhoneNumberTechType": null,
  "CosignerOtherPhoneNumberTechType": null,
  "CosignerFaxNumberTechType": null,
  "CosignerCreditFilePhoneTechType": null,
  "CosignerAlternatePhoneTechType": null,
  "CosignerFraudVictim": null
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Account updated successfully.",
    "Status": true,
    "ErrorCode": "ERR01003",
    "ResponseData": null
  }
}