Use the value in the ID column for the idType and idType2 parameters. Use the information in the Layout column to format the values for the id and id2 parameters.
See the Customer ID Verification (KYC/CIP) guide for more information.
These endpoints contain the ID-related parameters:
- Create Account
- Create Virtual Card Account
- Update Account
- Start Enrollment
- Update Enrollment
- Verify Enrollment
- Run Enrollment CIP
Where a date is required, it is the expiration date of the credential.
| ID | Description | Layout |
|---|---|---|
| 0 | PAN or PRN | PAN or PRN Example: 123456789012 |
| 1 | Driver's License Number | <DL# 1–20 alphanumeric>|<DL State 2 alpha>| <DL expiration mm-dd-yyyy> Example: abcd12345|UT|05-02-2020 |
| 2 | Social Security Number | 9 digits, all numeric. See Validation for ID type 2. Example:123456789 |
| 3 | Green Card Number | <9-digit green card ID>|<mm-dd-yyyy> Example: 123456789|05-02-2020 |
| 4 | Passport Number | <6–9 alphanumeric passport ID>|<mm-dd-yyyy> Example: abc1234|05-02-2020 |
| 5 | Visa Number | <4–15 alphanumeric Visa ID>|<mm-dd-yyyy> Example: abcd12345|05-02-2020 |
| 6 | Matricula Consular Number | <7–9 digit MCN ID>|<mm-dd-yyyy> Example: 123456789|05-02-2020 |
| 7 | RFDC | Alphanumeric 1–50 characters Example: abcdefgh1234567 |
| 8 | CDE | Alphanumeric 1–50 characters Example: abcdefgh1234567 |
| 9 | Social Insurance Number | 9 digits, all numeric Example: 123456789 |
| 10 | Citizenship Papers | Alphanumeric 1–50 characters Example: abcdefgh1234567 |
| 11 | Canadian Drivers License Number | <DL# 1–20 alphanumeric>|<DL Province 2 alpha>|<DL expiration mm-dd-yyyy> Example: abcd12345|NB|05-02-2020 |
| 12 | Card Details | Alphanumeric 1–50 characters Example: abcdefgh1234567 |
| 13 | State ID | <DL# 1–20 alphanumeric>|<DL State 2 alpha>|<DL expiration mm-dd-yyyy> Example: abcd12345|UT|05-02-2020 |
| 14 | Client-Generated ID | Alphanumeric 1–50 characters Example: abcdefgh1234567 |
| 15 | ITIN (Individual Tax Identification Number) | 9-digit ITIN ID Example: 123456789 |
Validation for ID type 2
In both the CV and Production environments, Social Security numbers are validated. If any of these conditions are true, the system returns an error:
- Starts with
9 - Starts with
000 - Starts with
666 - Has
00in the 2-digit segment (positions 4–5) - Has
0000in the 4-digit segment (positions 6–9)