4.5 Create Applicant with Full fixedInfo
Recommended single-shot approach: send the applicant profile, address, TIN, and required metadata in the create applicant request. A follow-up PATCH /fixedInfo is optional and normally used only when correcting or refreshing an existing applicant.
POST /resources/applicants?levelName=payblr-kyc-individuals-poa-batch
Content-Type: application/json
X-App-Token: <token>
X-App-Access-Ts: <unix-seconds>
X-App-Access-Sig: <signature>
{
"externalUserId": "user-92847-unique",
"email": "anna.krause@example.com",
"phone": "+491701234567",
"lang": "en",
"metadata": [
{ "key": "sourceKey", "value": "<payblr-assigned-source-key>" },
{ "key": "partnerName", "value": "Payblr-YourCompany" },
{ "key": "cardHolderId", "value": "ch-92847" },
{ "key": "customerPartnerId", "value": "user-92847" }
],
"fixedInfo": {
"firstName": "Anna",
"middleName": "Marie",
"lastName": "Krause",
"dob": "1990-05-15",
"country": "DEU",
"tin": "12345678901",
"addresses": [
{
"street": "Musterstrasse 1",
"town": "Berlin",
"state": "Berlin",
"country": "DEU",
"postCode": "10115"
}
]
}
}
Expected response: 201 with the Sumsub applicant ID. Save that value as applicantId.
4.6 Optional PATCH fixedInfo
PATCH /resources/applicants/{applicantId}/fixedInfo is optional when the create applicant call already includes complete fixedInfo.
Use it when:
- Updating profile, address, or TIN on an existing applicant.
- Retrying after corrected data.
- Resuming a partially completed submission.
4.7 Upload Documents
Each file is sent as a separate multipart/form-data request.
POST /resources/applicants/{applicantId}/info/idDoc
Content-Type: multipart/form-data; boundary=----...
X-Return-Doc-Warnings: true
Form Parts
| Part |
Content Type |
Value |
metadata |
application/json |
JSON metadata object. |
content |
Image MIME type |
Binary image file. |
Common Metadata Examples
{ "idDocType": "ID_CARD", "country": "DEU", "idDocSubType": "FRONT_SIDE" }
{ "idDocType": "ID_CARD", "country": "DEU", "idDocSubType": "BACK_SIDE" }
{ "idDocType": "UTILITY_BILL", "country": "DEU" }
{ "idDocType": "SELFIE", "country": "DEU" }