Customer management
Add ID details
4 min
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 onboarding documentation the tutorial assumes you have a knowledge of apis and how they work refer to structure for more details the tutorial uses this api endpoint true false 307false unhandled content type false unhandled content type false unhandled content type false unhandled content type before you begin make sure you have quickstart customer id (only available once the customer is onboard a customer ) 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 register relevant webhook events to receive the webhook events for this tutorial both partner accounts need to accounts, cards and payment events 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 add id information to existing record you might want or need to add a drivers license, passport or other identification to an existing customer record if your agreement with cross river includes {{bin}} , 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/{customerid}/identifications the attributes below are required a full list of attributes is found here true false 215,171false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type important we highly recommend you include an idempotency keys in your request header to provide duplicate protection in the event of a failure sample request curl x post \ header 'content type application/json' \ header 'accept application/json' \ header 'authorization bearer \<token>' d '{ \\ "isprimary" true, "idnumber" "123 456 789", "idtype" "driverslicense", "issueddate" "2022 07 15", "expdate" "2029 07 14", "verifieddate" "2023 05 21", "issuingauthority" "ny dmv", "issuingstateorprovince" "ny", "issuingcountrycode" "us", }' 'https //sandbox crbcos com/core/v1/cm/customers/b71cf966 7896 40a0 88c5 af5g0138fc8c/identifications' 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 response sample { "id" "6d3add34 0a1e 4a4e 9c7f b00a0091e308", "customerid" "b71cf966 7896 40a0 88c5 af5g0138fc8c", "isprimary" true, "idnumber" "123 456 789", "status" "active", "idtype" "driverslicense", "issueddate" "2022 07 15", "expdate" "2029 07 14", "issuingauthority" "ny dmv", "issuingstateorprovince" "ny", "issuingcountrycode" "us", "createdat" "2023 05 22t04 51 09 4656083 04 00", "lastmodifiedat" "2023 05 22t04 51 09 4656083 04 00", "partnerid" "cd9c12f4 7691 424a b38b af5b0134c611" } important it's up to you to keep this information up to date