Account Creation
Action: POST
Endpoint: /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 details
| Fields | Description |
|---|---|
|
Source string Mandatory |
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 Mandatory |
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 Mandatory |
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 Optional |
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 Conditional |
ID of the Store where account is to be created. Valid Values: As provided by CoreCard Example: 13432 Condition: If PII information is set as mandatory on product, then this tag is mandatory. |
|
CreditLimit decimal Optional |
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:Mr Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. 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: 50 |
|
MiddleName string Optional |
Applicant's Middle Name Valid Values: A-Z,0-9 Example: K Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
LastName string Conditional |
Applicant's last name. Valid Values: A-Z,0-9 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: 50 |
|
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: 25 |
|
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. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. 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. Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 5 |
|
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. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 256 |
|
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 Conditional |
Applicant's employer name. Valid Values: A-Z, 0-9 Condition: If PII information is set as mandatory on product, then this tag is mandatory. 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 Conditional |
Applicant's Social Security Number Format: AAAGGSSSS Example: 078051120 Condition: If PII information is set as mandatory on product, then this tag is mandatory. Allowable Values: 9 |
|
IDType string Conditional |
Type of Government issued identification. Valid Values:Refer Appendix section 5.2 Example: 10 Condition: This field will become mandatory basis following two conditions: 1.For US State Cards This field is mandatory only when ID Type on product is set as Yes for Card Type = Primary. 2.For Non-US State cards This field is mandatory only when ID Type (Non-US) on product is set as Yes for Card Type=Primary. 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: 30 |
|
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. 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 Conditional |
Total Annual Income of applicant. Valid Values: 0-9 Format: XXX.XX Example: 500.00 Condition: If PII information is set as mandatory on product, then this tag is mandatory. |
|
CurrentEmploymentMonths string Conditional |
Number of months in current employment. Valid Values: 0-9 Example: 10 Condition: If PII information is set as mandatory on product, then this tag is mandatory. Allowable Values: 10 |
|
Position string Optional |
Employement position of the applicant. Valid Values: A-Z, 0-9 Example: Manager Allowable Values: 100 |
|
EmploymentType string Conditional |
Type of employment of applicant Valid Values:Refer Appendix Section - Employment Type Example: 1 Condition: If PII information is set as mandatory on product, then this tag is mandatory. 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 Conditional |
Duration on residence in months. Valid Values: 0-9 Example: 50 Condition: If PII information is set as mandatory on product, then this tag is mandatory. |
|
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: 25 |
|
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: 30 |
|
ShippingCountry string Conditional |
Shipping address Country name. Valid Values: Refer Appendix Section Country Code Values Condition: If ShippingAddressFlag is 1 then it is mandatory Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 5 |
|
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 |
Art/Template ID based on this Card’s Image will be displayed. Valid Values: 0-9, a-z Example: 30abc 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. Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. 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. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CoApplicantMiddleName string Optional |
Co-Applicant’s Middle Name Valid Values: A-Z,0-9 Example: Smith Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CoApplicantLastName string Conditional |
Co-Applicant’s Last Name Valid Values: A-Z,0-9 Example: Davis Condition: If Co-Applicant Flag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
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. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CoApplicantAddressLine2 string Optional |
Co-Applicant’s Address line2 Example: Park Avenue Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. 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. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CoApplicantState string Conditional |
Co-Applicant’s State. Valid Values: Refer Appendix Section State Codes. Example: AL Condition: If Co-Applicant Flag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 30 |
|
CoApplicantPostalCode string Conditional |
Co-Applicant’s postal code. Valid Values: 0-9 Example: 12345-6789 Condition: If Co-Applicant Flag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 9 |
|
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. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 256 |
|
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: 256 |
|
UserFieldValue2 string Optional |
User Defined Tag Allowable Values: 256 |
|
UserFieldValue3 string Optional |
User Defined Tag Allowable Values: 256 |
|
UserFieldValue4 string Optional |
User Defined Tag Allowable Values: 256 |
|
UserFieldValue5 string Optional |
User Defined Tag Allowable Values: 256 |
|
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-No,1-Yes Format: xx Example: 0/1 Condition: If the Tag IsMLAAccount (Existing Tag) is marked as Yes then either IsApplicantMLA or IsCosignerMLA or Both tag must be marked as Yes. |
|
IsCosignerMLA integer Conditional |
Flag to identify Cosigner as MLA Valid Values: 0-No,1-Yes Format: xx Example: 0/1 Condition: If the Tag IsMLAAccount (Existing Tag) is marked as Yes then either IsApplicantMLA or IsCosignerMLA or Both tag must be marked as Yes. |
|
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 Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 10 |
|
CosignerFirstName string Conditional |
Cosigner's First Name valid Values:A-Z,0-9 Example:John Condition:If CosignerFlag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CosignerMiddleName string Optional |
Cosigner's Middle Name valid Values:A-Z,0-9 Example:Smith Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CosignerLastName string Conditional |
Cosigner's Last Name valid Values:A-Z,0-9 Example:Davis Condition:If CosignerFlag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. 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. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CosignerAddressLine2 string Optional |
Cosigner's Address Line 2 valid Values:A-Z, 0-9 Example:123 HWY Condition: Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CosignerCity string Conditional |
Cosigner's City valid Values:A-Z,0-9 Example:Chicago Condition:If CosignerFlag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CosignerState string Conditional |
Cosigner's State valid Values: Refer Appendix Section State Codes Condition:If CosignerFlag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 50 |
|
CosignerPostalCode string Conditional |
Cosigner's Postal Code valid Values:0-9 Format:XXXXX Example:99501 Condition:If CosignerFlag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 9 |
|
CosignerCountry string Conditional |
Cosigner's Country Valid Values:Refer appendix section Country Code Values Example:US Condition:If CosignerFlag = 1 then mandatory. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 5 |
|
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. Please refer Appendix Section 5.50 (Vendor wise field length) for field length supported by embossing vendor. Allowable Values: 256 |
|
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 3-Standard Exp 4-Priority Exp 5-Overnight Exp Example:0 Condition:i. Default value for this tag is '0-Standard'. ii. If a new method is added then Corecard will communicate the code of it. iii.Condition:Values3,4,5 are only applicable for Perfect Plastic Card Vendor 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 |
|
RelationshipFlag integer Optional |
Flag to identify if the customer is existing customer or not. Based on this flag any extra benefit can be provide to Cardholder like Relationship bonus to existing customer. Valid Values: 0 - No 1 – Yes Format: X Example: 0 |
|
RewardRuleID integer Optional |
Reward Rule ID to be mapped on the Account. Valid Values: 0-9 (Value provided by Corecard) Example:1234 |
|
PortfolioID string Optional |
Indicates details of lender institution mapped on account. Valid Values: Under special characters only Hypen (-) and Underscore (_) are allowed. No spaces allowed in between strings Example: Under special characters only Hypen (-) and Underscore (_) are allowed. No spaces allowed in between strings |
|
CosignerSNSuffix 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 |
|
PromoBTAllow string Conditional |
PromoBTAllow. Valid Values: 0-9 Example: 1234 |
|
StandardBTAllow string Conditional |
StandardBTAllow. Valid Values: 0-9 Example: 1234 |
|
CardLevelUserFieldValue1 string Optional |
Card Level User Field value Valid Values: A-Z,0-9 Example: Primary Allowable Values: 256 |
|
CardLevelUserFieldValue2 string Optional |
Card Level User Field value Valid Values: A-Z,0-9 Example: Primary Allowable Values: 256 |
|
CardLevelUserFieldValue3 string Optional |
Card Level User Field value Valid Values: A-Z,0-9 Example: Primary Allowable Values: 256 |
|
CardLevelUserFieldValue4 string Optional |
Card Level User Field value Valid Values: A-Z,0-9 Example: Primary Allowable Values: 256 |
|
CardLevelUserFieldValue5 string Optional |
Card Level User Field value Valid Values: A-Z,0-9 Example: Primary Allowable Values: 256 |
|
CardLevelUserFieldValue6 string Optional |
Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
CardLevelUserFieldValue7 string Optional |
Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
CardLevelUserFieldValue8 string Optional |
Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
CardLevelUserFieldValue9 string Optional |
Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
CardLevelUserFieldValue10 string Optional |
Card Level User Field value, When Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
UserFieldValue21 string Optional |
Account Level User Field value, when Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
UserFieldValue22 string Optional |
Account Level User Field value, when Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
UserFieldValue23 string Optional |
Account Level User Field value, when Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
UserFieldValue24 string Optional |
Account Level User Field value, when Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
UserFieldValue25 string Optional |
Account Level User Field value, when Card Level User Field is defined as Drop Down of Text Type then Valid value of Drop Down should be retrieved using GetUserFieldDetails API and then provided in this field. Valid Values: A-Z,0-9 Example: Yes Allowable Values: 256 |
|
AssociationProductType string Optional |
Codes of the Association Product Types will be allowed to be passed in the API Format:XXXXXX Example: MC07, MC08 Allowable Values: 20 |
|
RewardID string Optional |
Reward ID to be mapped on the Account. Valid Values: 0-9, a-z Allowable Values: 25 |
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,
"CosignerSNSuffix": 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,
"RelationshipFlag": null,
"RewardRuleID": null,
"PortfolioID": null,
"PromoBTAllow": null,
"StandardBTAllow": null,
"CardLevelUserFieldValue1": "Primary",
"CardLevelUserFieldValue2": "Primary",
"CardLevelUserFieldValue3": "Primary",
"CardLevelUserFieldValue4": "Primary",
"CardLevelUserFieldValue5": "Primary",
"CardLevelUserFieldValue6": "Primary",
"CardLevelUserFieldValue7": "Primary",
"CardLevelUserFieldValue8": "Primary",
"CardLevelUserFieldValue9": "Primary",
"CardLevelUserFieldValue10": "Primary",
"UserFieldValue21": "Yes",
"UserFieldValue22": "Yes",
"UserFieldValue23": "Yes",
"UserFieldValue24": "Yes",
"UserFieldValue25": "Yes",
"AssociationProductType": null,
"RewardID": null
}
Response fields details
| 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
{
"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"
}
}