Sumsub Know Your Customer (KYC) Integration Guide
6. KYC Results
Before submitting an applicant for review, confirm that all required KYC steps are fulfilled, then move the applicant to pending and retrieve the final review result through the configured result delivery method.
6.1 Submitting for Review and Getting Results
Before requesting review, call:
GET /resources/applicants/{applicantId}/requiredIdDocsStatusConfirm every required step is fulfilled. Then request review:
POST /resources/applicants/{applicantId}/status/pendingAfter this call, the applicant is queued for automated or manual review and may be locked for editing until review completes or is reset.
Result Options
Production
Production integrations should use the applicantReviewed webhook for final result handling.
Early Integration
Polling GET /resources/applicants/{applicantId}/status is acceptable during early integration and testing.
Example Completed Response
{
"reviewStatus": "completed",
"reviewResult": {
"reviewAnswer": "GREEN",
"reviewRejectType": null,
"rejectLabels": []
}
}6.2 KYC Result Handling
The main result object is reviewResult. The primary decision field is reviewResult.reviewAnswer.
| Scenario | Sumsub Indicator | Expected Payblr Handling |
|---|---|---|
| Approved applicant | reviewResult.reviewAnswer = GREEN | Applicant may continue in Payblr onboarding, subject to Payblr rules. |
| Rejected applicant | reviewResult.reviewAnswer = RED | Evaluate reviewRejectType, rejectLabels, and comments. |
| Resubmission required | reviewAnswer = RED with reviewRejectType = RETRY | Applicant must correct or resubmit information. |
| Final rejection | reviewAnswer = RED with reviewRejectType = FINAL | Applicant must not continue onboarding. |
| PEP match | AML or compliance screening result, or rejectLabels, indicates PEP. | Route to compliance review. Do not auto-approve. |
| AML or sanctions hit | AML screening result or labels such as SANCTIONS, ADVERSE_MEDIA, or RESTRICTED_PERSON. | Route to compliance review or reject according to Payblr rules. |
| Missing required data | Step status issue or labels such as ADDITIONAL_DATA_REQUIRED, ADDITIONAL_DOCUMENT_REQUIRED, MORE_DOCUMENTS_REQUIRED, or NOT_ALL_CHECKS_COMPLETED. | Keep pending or request resubmission/correction. |
Important: PEP, AML, sanctions, and missing-data scenarios are not separate top-level reviewAnswer values. They are handling categories derived from review results, AML screening outputs, verification step status, and rejection labels.
6.3 Predefined Values
The values below represent the predefined options expected for questionnaire fields and applicant identity data mapping.
| Field | Allowed Values |
|---|---|
| Work Status | Contractor, Full Time, Intern, Other, Part Time, Retired, Self Employed, Student, Temporary, Unemployed, Volunteer. |
| Source of Funds | Business Income, Family or Inheritance, Freelance Income, Government Benefits, Investment Income, Loan, Rental Income, Retirement Income, Salary, Sale of Assets, Savings. |
| Expected Monthly Transaction Volume |
|
| Estimated Annual Income | Less than $25,000, $25,000 - $49,999, $50,000 - $74,999, $75,000 - $99,999, $100,000 - $149,999, $150,000 - $199,999, $200,000 - $299,999, $300,000+. |
Industry Values
- Accommodation and Food Services
- Administrative, Support, Waste Management and Remediation Services
- Agriculture, Forestry, Fishing and Hunting
- Arts, Entertainment and Recreation
- Construction
- Educational Services
- Finance and Insurance
- Health Care and Social Assistance
- Information
- Management of Companies and Enterprises
- Manufacturing
- Mining, Quarrying and Oil and Gas Extraction
- Other Services
- Professional Scientific and Technical Services
- Public Administration
- Real Estate, Rental and Leasing
- Retail Trade
- Transportation and Warehousing
- Utilities
- Wholesale Trade
Occupation Values
- Accounting
- Analyst
- Architect
- Artist
- Athlete
- Consultant
- Content Creator
- Customer Service
- Data Analyst
- Designer
- Engineer
- Entertainer
- Executive
- Financial Services
- Fitness Instructor
- Food Service Worker
- Government Worker
- Graphic Designer
- Homemaker
- Hospitality Worker
- Laborer
- Law Enforcement
- Legal Professional
- Manager
- Media & Communications
- Medical Professional
- Military
- Real Estate Professional
- Retired
- Sales Representative
- Software Engineer
- Student
- Supervisor
- Teacher
- Technician
- Technology/IT
- Translator
- Travel Industry Worker
- Unemployed
- UX/UI Designer
- Video Editor
- Volunteer
- Web Developer
- Writer
Country / Jurisdiction Values
Use the country or passport jurisdiction values configured for the Payblr Sumsub level. Keep values aligned with the approved onboarding configuration.
These values should be used exactly as configured for the applicant questionnaire and identity data mapping. If a client needs an option that is not listed, confirm the value with Payblr before implementation.
Next steps
Continue to Data Mapping Requirements for the required applicant fields, metadata, and identity data mapping used across SDK and API flows.