Overview
Use this method to retrieve a preview of an applicant profile before performing the actual import into the recipient key using the Copy applicant profile method.
For example, you want to check the applicant status first and proceed with the copy only if the applicant is approved.
Note
You can reuse the same
shareToken— for example, first with the preview endpoint and then with the actual applicant copy method.
Request example
curl -X POST \
'https://api.sumsub.com/resources/applicants/-/import/preview?shareToken=_act-jwt-eyJhbGciOiJub25lIn0.eyJqdGkiOiJfYWN0LTc4ZDNlYjRkLWQ3Y2EtNDFhYS05N2Y2LTYxMjU4ODQ3YTRmZSIsInVybCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA5MCJ9.' \
-H 'Authorization: Bearer token'
Response explained
The response is a JSON file representing the applicant profile data and applicant status. You can see the response structure, possible content with descriptions, and examples on the following page.
Note
The response returns only the applicant's current status and review data. It does not include document images and results of specific checks.
Response example
If the request is successfully sent and processed, you will get a response like the one below.
{
"id": "6908992ea9c4d8125fg57hju",
"createdAt": "2025-11-03 11:59:42",
"clientId": "cool_client_id",
"inspectionId": "6908992ea9c4d8548ddfr47y",
"externalUserId": "preview-random-0000000000",
"info": {
"firstName": "John",
"firstNameEn": "John",
"lastName": "Mock-Doe",
"lastNameEn": "Mock-Doe",
"aliasName": "Mock aliasName",
"dob": "2006-05-07",
"country": "DEU",
"idDocs": [
{
"idDocType": "ID_CARD",
"country": "DEU",
"firstName": "John",
"firstNameEn": "John",
"lastName": "Mock-Doe",
"lastNameEn": "Mock-Doe",
"aliasName": "Mock aliasName",
"issuedDate": "2016-02-04",
"validUntil": "2026-10-25",
"number": "Mock-HXND7AYHVE",
"dob": "2006-05-07",
"mrzLine1": "I<IRL44QI4ZXXXX<<<<<<<<<<<<<<<",
"mrzLine2": "0812236M2806170IRL<<<<<<<<<<<2",
"mrzLine3": "DOE<<JOHN<<<<<<<<<<<<<<<<<<<",
"termless": false
}
]
},
"email": "[email protected]",
"applicantPlatform": "Web",
"agreement": {
"items": [
{
"id": "e19145b7-319f-4cbc-8061-fffc3dc7d4a3",
"acceptedAt": "2025-11-03 12:00:12",
"source": "WebSDK",
"type": "onboarding",
"recordIds": [
"684fc8717056c9d53e87ed95"
]
}
],
"createdAt": "2025-11-03 12:00:12",
"acceptedAt": "2025-11-03 12:00:12",
"source": "WebSDK",
"recordIds": [
"684fc8717056c9d53e87ed95"
]
},
"requiredIdDocs": {
"docSets": [
{
"idDocSetType": "IDENTITY",
"types": [
"DRIVERS",
"ID_CARD",
"RESIDENCE_PERMIT",
"PASSPORT"
],
"videoRequired": "disabled",
"nfcVerificationSettings": {
"mode": "disabled"
}
},
{
"idDocSetType": "SELFIE",
"types": [
"SELFIE"
],
"videoRequired": "passiveLiveness"
}
]
},
"review": {
"reviewId": "KQJFd",
"attemptId": "tEtNo",
"attemptCnt": 1,
"elapsedSincePendingMs": 1342,
"elapsedSinceQueuedMs": 1342,
"reprocessing": true,
"levelName": "kyc-basic-level",
"createDate": "2025-11-03 12:01:36+0000",
"reviewDate": "2025-11-03 12:01:37+0000",
"reviewResult": {
"reviewAnswer": "GREEN"
},
"reviewStatus": "completed",
"priority": 0
},
"lang": "en",
"type": "individual"
}
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 401,
"correlationId": "2f6ffcee33152ae571139b2537fc2359",
"description": "Token is invalid, make sure you generate a new one each time, because the old ones are invalidated upon usage"
}