Add ID details
In this tutorial, you'll learn how to:
✅ Update a COS customer record with physical ID metadata or other identification information.
If you are new to customer management, we recommend you read our Customer Management documentation.
The tutorial assumes you have a knowledge of APIs and how they work. Refer to the API overview page for more details.
The tutorial uses these API endpoints
API | Description |
|---|---|
POST /core/v1/cm/customers/{id}/identifications | Adds unique identification metadata of customer-identifying documents to customer details. |
Make sure you have:
- The necessary details for the identification you are adding to the customer record. Depending on the type of identification, you might need:
- ID serial number
- Expiration date
- Details of the issuing authority
- Other information
To receive the webhook events for this tutorial both partner accounts need to register each specific webhook event type. Once you are registered, the event objects are sent to the registered URLs.
The event object contains a list of resource identifiers used to download details on each event.
You might want or need to add a drivers license, passport or other identification to a customer record. If your agreement with CR includes credit BIN sponsorship , you need to add the card processor unique identifier for that customer to their COS record.
In this tutorial, you'll add a driver's license to Peter Griffin's customer record.
Call POST /core/v1/cm/customers/{id}/identifications. The attributes below are required. A full list of attributes is found here.
Detail | Request attribute name | Value to use in the request |
|---|---|---|
CR customer ID (provided when the customer was onboarded to COS) | customerId | ID from the Onboard a customer tutorial |
True if the ID is the primary ID for this customer. Otherwise false. | isPrimary | true |
License ID number | idNumber | 123 456 789 |
ID type | idType | DriversLicense |
License Issue date | issuedDate | 2022-07-15 |
License Expiration date | expDate | 2029-07-14 |
License Issuing authority | issuingAuthority | New York DMV |
License Issuing country code | issuingCountryCode | US |
IMPORTANT We highly recommend you include an idempotency key in your request header to provide duplicate protection in the event of a failure.
A successful API call returns a JSON response confirming the identification details added in COS. The id attribute indicates the COS ID of that specific identification item. In the sample below, the ID is 6d3add34-0a1e-4a4e-9c7f-b00a0091e308. Yours will be different.
IMPORTANT It's up to you to keep this information up to date.
