get
https://api.sumsub.com/resources/checks/latest?type=NFC
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Use this method to retrieve NFC-based ID verification check results based on the data extracted from the applicant’s compatible identity documents.
Required permissions
To use this method, your app token must have the View check results permission.
Request example
curl -X GET \
'https://api.sumsub.com/resources/checks/latest?applicantId=66bb9b44fc99ec3ef8y5ppph&type=NFC' \
-H 'X-App-Token: <your-app-token>' \
-H 'X-App-Access-Sig: <your-signature>' \
-H 'X-App-Access-Ts: <unix-timestamp>'Response explained
The response represents a list of checks.
Root variables
The root variables are the core check result data items. Some of them may include nested attributes and element fields.
| Field | Type | Description |
|---|---|---|
answer | String | Overall result of the NFC check.
nfcCheckInfo.validCertificate separately to see whether the document certificate was valid and current — answer can be GREEN while validCertificate is RED. |
checkType | String | Indicates this is the NFC check type. |
createdAt | Date | Date and time (UTC) of the latest NFC check result. |
id | String | Unique identifier of the check. |
inputDoc | Object | Defines the document used for the check. |
nfcCheckInfo | Object | Details of the NFC check results. |
inputDoc attributes
inputDoc attributes| Field | Type | Description |
|---|---|---|
idDocType | String | Type of document used for NFC-based ID verification. |
country | String | Alpha-3 code (for example, DEU, GBR, ARG) of the country where the document was issued. |
nfcCheckInfo attributes
nfcCheckInfo attributes| Field | Type | Description |
|---|---|---|
validCertificate | String | Indicates whether the document certificate is valid and current.
|
extractedData | Object | Includes the data obtained through the NFC chip of identity documents. |
processingErrors | Array of objects | Each error object contains a reason field explaining the cause of the error (for example, userCancelled, userSkipped). |
validation | Object | Contains the results of validation checks performed during NFC verification. |
extractedData attributes
extractedData attributessignedData attributes
signedData attributes| Field | Type | Description |
|---|---|---|
issuerPrincipal | String | Refers to the identity of the entity that issued the document. |
mrzInfo attributes
mrzInfo attributes| Field | Type | Description |
|---|---|---|
fullMrz | String | Contains the full Machine-Readable Zone (MRZ) data from the ID document. |
dateOfExpiration | Date | Document expiration date. Presented as a UNIX timestamp. |
documentNumber | String | Document registration number. |
issuingState | String | ISO 3166-1 code of the country or state that issued the document (for example, DEU, GBR, ARG).Refer to the list of countries and document types that are available via Sumsub NFC verification. |
nationality | String | Applicant's country of origin as specified in the document. Presented as an ISO 3166-1 country code (for example, DEU, GBR, ARG). |
identifier | String | Name of the user. |
dob | Date | Applicant's date of birth. Presented as a UNIX timestamp. |
gender | String | Gender of the applicant (M, F, or X). This field can be omitted if not specified. |
images attributes
images attributes| Field | Type | Description |
|---|---|---|
faceMimeType | String | Indicates the type and format of the image for the "face" field (for example, image/jpeg, image/png). |
validation attributes
validation attributes| Field | Type | Description |
|---|---|---|
accessControlStatus | Object | Contains the results of access control checks performed during NFC verification. |
activeAuthentication | Object | Contains the result of active authentication performed on the document chip. |
certificateChain | Array of objects | Contains information about certificates in the document certificate chain. |
certificateMasterListCheck | Boolean | Indicates whether the document certificate passed validation against the certificate master list. |
certificateSelfCheck | Boolean | Indicates whether the document certificate passed the self-check. |
hashValidation | Object | Contains the results of hash validation for data read from the document chip. |
accessControlStatus attributes
accessControlStatus attributesAccess control check attributes
The following attributes apply to the bac, eacta, and pace objects.
| Field | Type | Description |
|---|---|---|
errorCode | String | Error code returned for the access control check. |
status | String | Status of the access control check. Available options: success, unknown, error. |
activeAuthentication attributes
activeAuthentication attributes| Field | Type | Description |
|---|---|---|
errorCode | String | Error code returned for the active authentication check. |
status | String | Status of the active authentication check. Available options: success, unknown, error. |
certificateChain element fields
certificateChain element fields| Field | Type | Description |
|---|---|---|
name | String | Name of the certificate in the document certificate chain. |
hashValidation attributes
hashValidation attributes| Field | Type | Description |
|---|---|---|
images | Boolean | Indicates whether image data read from the document chip passed hash validation. |
mrzInfo | Boolean | Indicates whether MRZ information read from the document chip passed hash validation. |
Response examples
If the request is successfully sent and processed, you will get a response like one of those below.
// The document chip has been read and the document certificate is valid.
{
"checks": [
{
"answer": "GREEN",
"checkType": "NFC",
"createdAt": "2025-08-07 11:16:21",
"id": "e52cb57b-0e7a-4e46-8a3b-3cc490516802",
"inputDoc": {
"idDocType": "ID_CARD",
"country": "KAZ"
},
"nfcCheckInfo": {
"validCertificate": "GREEN",
"extractedData": {
"signedData": {
"issuerPrincipal": "CN=Certificate Authority Offline-1, OU=eDocuments and eID, O=Republic of Kazakhstan, C=KZ"
},
"mrzInfo": {
"fullMrz": "IDKAZ0533757222910000000000<<<\n9104071M0000000KAZ<<<<<<<<<<<9\nDOE<<JOHN<<<<<<<<<<<<<<<<<\n",
"dateOfExpiration": 1973721600000,
"documentNumber": "100000089",
"issuingState": "KAZ",
"nationality": "KAZ",
"identifier": "DOE JOHN",
"dob": 670982400000,
"gender": "M"
},
"images": {
"faceMimeType": "image/jpeg"
}
}
}
}
]
}// The document chip has been read but the document certificate is invalid.
{
"checks": [
{
"answer": "GREEN",
"checkType": "NFC",
"createdAt": "2025-08-07 11:16:21",
"id": "e52cb57b-0e7a-4e46-8a3b-3cc490500000",
"inputDoc": {
"idDocType": "ID_CARD",
"country": "KAZ"
},
"nfcCheckInfo": {
"validCertificate": "RED",
"extractedData": {
"mrzInfo": {
"documentNumber": "100000000",
"issuingState": "KAZ",
"nationality": "KAZ",
"identifier": "DOE JOHN",
"dob": 670982400000,
"gender": "M"
}
}
}
}
]
}// The document chip could not be read (processing error).
{
"checks": [
{
"answer": "RED",
"checkType": "NFC",
"createdAt": "2025-08-05 14:06:23",
"id": "36c65d0e-0760-43e0-ae2c-acfc14d50efe",
"inputDoc": {
"idDocType": "ID_CARD",
"country": "KAZ"
},
"nfcCheckInfo": {
"processingErrors": [
{
"reason": "userCancelled"
}
]
}
}
]
}// Empty `checks` array means the NFC check was not performed for this applicant.
{
"checks": []
}If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 404,
"description": "Applicant with id 682e260519dabfbd86d9b45d not found",
"type": "de.smtdp.commons.service.exceptions.ServiceException"
}