4a - Append Document to Customer

POST /api/customer/{customerId}/document

cURL

Upload (front + document)

curl -X POST "{{backend_url}}/api/customer/{customerId}/document" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: 6603" \
  -F "front=@front.png;type=image/png" \
  -F 'document={"type":"NATIONAL_ID","number":"S1234567A"};type=application/json'

This endpoint allows you to upload one or two document images (front, back) and attach them to a Primary Customer record.

The request is multipart/form-data and includes:

• front (required): front image file.
• back (optional): back image file.
• document (required): JSON metadata describing the document.

---

Document Type Values

The field document.type must be one of the following values:

• NATIONAL_ID
• PASSPORT
• DRIVING_LICENSE
• OTHERS

---

How to Retrieve Customer IDs

You’ll need identifiers to call these endpoints:

• customerId (Primary Customer):

  • Returned in the response when you create a customer, or
  • Retrieve via search → Step 3b — Get a Single Primary Customer

• customerId (CRP under a Primary Customer):

  • Returned in the response when you create as a CRP, or
  • Listed under the customer’s CRPs → Step 3c — Get CRPs of a Customer

---

Example Requests

Primary Customer — with only front and document

curl -X POST "{{backend_url}}/api/customer/{customerId}/document" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: 6603" \
  -F "front=@front.png;type=image/png" \
  -F 'document={"type":"NATIONAL_ID","number":"S1234567A","authenticity":"ORIGINAL","issueDate":"2020-01-01","expiryDate":"2030-01-01","showExpiryNotification":true};type=application/json'

Authorizations

OAuth2_Client_CredentialsOAuth2_Password

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID · integer<int64> · required

X-Domain-ID

Path Parameters

customerId · integer<int64> · required

customerId

Body

multipart/form-data

front · file · required

Front image file (required)

document · object · required

JSON metadata for the document

Show child attributes

back · file

Back image file (optional)

Response

200

Document uploaded successfully