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 docid 8ytxcoj1zucpzfxmnbvwt documentation the tutorial assumes you have a knowledge of apis and how they work refer to the api basics docid\ hjr4y6ml96zuyj6trytom 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 before you begin make sure you have bank rails docid\ kbym9o05dwmdjsf8k7lzi customer id (only available once the customer is onboard a customer docid\ njfm wjxq0eokx4pfn3b6 ) 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 the relevant webhook events to receive the webhook events for this tutorial both partner accounts need to banking and payments webhooks docid\ dgnysfx9f7pnesmuxnwsp 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 identification information to an existing customer 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 docid\ dbsuyh15euk26uxa9isml , 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 docid\ njfm wjxq0eokx4pfn3b6 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 docid\ jiv0q1 cymjqqger3ijmp 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