Sumsub Know Your Customer (KYC) Integration Guide
7. Data Mapping Requirements
The table below maps Payblr onboarding data to the corresponding Sumsub applicant fields, metadata keys, questionnaire values, and document submission requirements.
On this page
| Area | Payblr Field | Required | Sumsub Path / Key |
|---|---|---|---|
| Metadata | Client/program identifier | Yes | metadata[].key = sourceKey |
| Metadata | Partner ID | Yes | metadata[].key = partnerName |
| Metadata | Cardholder ID | Yes | metadata[].key = cardHolderId |
| Metadata | Customer ID, from partner | Optional | metadata[].key = customerPartnerId |
| Metadata | Card Number ID | Optional | metadata[].key = cardNumberId |
| Metadata | Account ID | Optional | metadata[].key = accountid |
| Metadata | Account Open Date | Optional | metadata[].key = accountOpenDate |
| Metadata | AML Risk Score | Optional | metadata[].key = amlRiskScore |
| Metadata | AML Last Risk Score Date | Optional | metadata[].key = amlLastRiskScoreDate |
| Profile | First Name | Yes | fixedInfo.firstName |
| Profile | Middle Name | Optional | fixedInfo.middleName |
| Profile | Last Name | Yes | fixedInfo.lastName |
| Profile | Date of Birth | Yes | fixedInfo.dob |
| Profile | Yes | email | |
| Profile | Phone | Yes | phone |
| Profile | TIN | Yes | fixedInfo.tin |
| Address | Address Line 1 | Yes | fixedInfo.addresses[].street |
| Address | Address Line 2 | Optional | fixedInfo.addresses[].subStreet |
| Address | City | Yes | fixedInfo.addresses[].town |
| Address | State or Province | Yes — if present | fixedInfo.addresses[].state |
| Address | Country | Yes | fixedInfo.addresses[].country |
| Address | Postal Code | Yes | fixedInfo.addresses[].postCode |
| Questionnaire | Occupation | Yes | questionnaires[].sections.workAndIncome.items.occupation.value |
| Questionnaire | Industry You Work For | Yes | questionnaires[].sections.workAndIncome.items.industryYouWorkFor.value |
| Questionnaire | Work Status | Yes | questionnaires[].sections.workAndIncome.items.workStatus.value |
| Questionnaire | Source of Funds | Yes | questionnaires[].sections.section2.items.sourceOfFunds.value |
| Questionnaire | Expected Monthly Transaction Volume | Yes | questionnaires[].sections.section2.items.expectedMonthVolume.value |
| Questionnaire | Estimated Annual Income | Yes | questionnaires[].sections.section2.items.expectedAnnualIncome.value |
| Questionnaire | Card Terms Acceptance | Yes | questionnaires[].sections.cardholderAgreementA.items.cardTermsConditionsAccept.value |
| Identity docs | Document number, country, expiration | At least 1 doc | info.idDocs[].number,info.idDocs[].country,info.idDocs[].validUntil,info.idDocs[].idDocType |
| Proof of address | Dedicated PoA document | Conditional | idDocType: UTILITY_BILL upload when PROOF_OF_RESIDENCE remains unsatisfied. |
Next steps
Continue to Error Handling and Retry Logic for how to handle failed submissions, RED outcomes, and resubmission flows.