API Reference
API ReferenceChangelogFAQDashboard

Get NFC verification results

get https://api.sumsub.com/resources/checks/latest?type=NFC

Overview

Use this method to retrieve NFC-based ID verification check results based on the data extracted from the applicant’s compatible identity documents.

Request example

curl -X GET \
     'https://api.sumsub.com/resources/checks/latest?applicantId=66bb9b44fc99ec3ef8y5ppph&type=NFC'

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.

FieldTypeDescription
answerStringCheck answer.
  • GREEN — the check was processed and completed successfully.
  • RED — the check returned a negative result.
checkTypeStringIndicates this is the NFC check type.
createdAtDateDate and time (UTC) of the latest NFC check result.
idStringUnique identifier of the check.
inputDocObjectDefines the document used for the check.
nfcCheckInfoObjectDetails of the NFC check results.

inputDoc attributes

FieldTypeDescription
idDocTypeStringType of document used for NFC-based ID verification.
countryStringAlpha-3 code (e.g., DEU, GBR, ARG) of the country where the document was issued.

nfcCheckInfo attributes

FieldTypeDescription
validCertificateStringIndicates whether a document is valid and up to date (GREEN) or not (RED).
extractedDataObjectIncludes the data obtained through the NFC chip of identity documents.
processingErrorsArray of objectsEach error object contains a reason field explaining the cause of the error (e.g., userCancelled, userSkipped).

extractedData attributes

FieldTypeDescription
signedDataObjectIncludes the data that has been cryptographically signed to prove its authenticity and integrity.
mrzInfoObjectContains the MRZ (Machine-Readable Zone) data extracted from the ID document.
imagesObjectIncludes the data on the images uploaded.

signedData attributes

FieldTypeDescription
issuerPrincipalStringRefers to the identity of the entity that issued the document.

mrzInfo attributes

FieldTypeDescription
fullMrzStringContains the full Machine-Readable Zone (MRZ) data from the ID document.
dateOfExpirationDateDocument expiration date. Presented as a UNIX timestamp.
documentNumberStringDocument registration number.
issuingStateStringISO 3166-1 code of the country or state that issued the document (e.g., DEU, GBR, ARG).

Refer to the list of countries and document types that are available via Sumsub NFC verification.
nationalityStringApplicant's country of origin as specified in the document. Presented as an ISO 3166-1 country code (e.g., DEU, GBR, ARG).
identifierStringName of the user.
dobDateApplicant's date of birth. Presented as a UNIX timestamp.
genderStringGender of the applicant (M, F, or X). This field can be omitted if not specified.

images attributes

FieldTypeDescription
faceMimeTypeStringIndicates the type and format of the image for the "face" field (e.g., image/jpeg, image/png).

Response examples

If the request is successfully sent and processed, you will get a response like one of those below.

{
    "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"
                    }
                }
            }
        }
    ]
}

{
    "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"
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!