Documentation
API ReferenceChangelogFAQDashboard

Handle Address Verification results

Analyze Non-Doc Address Verification data to clarify rejection and approval reasons.

Once the check is performed, you will receive a webhook with the verification status:

  • The reviewResult object contains extra information about verification.
  • The reviewAnswer field contains the final verification result, displaying the GREEN or RED status:
    • GREEN — the applicant has passed Non-Doc Address Verification and their data has been successfully obtained from the government database.
    • RED — the applicant has not passed verification; the reviewRejectType is set to RETRY or FINAL.

Get verification check details

To get a structured view of the applicant data, use this API method with the type parameter set to RESIDENCY_CHECK.

curl --request GET \
     --url 'https://api.sumsub.com/resources/checks/latest?type=RESIDENCY_CHECK&applicantId=668b827860f280647fa07091' \

Example response:

{
  "checks" : [ {
    "answer" : "GREEN",
    "checkType" : "RESIDENCY_CHECK",
    "createdAt" : "2024-06-24 14:48:23",
    "id" : "26b26121-514a-4320-b64c-adf5b4188cb6",
    "inputDoc" : {
      "idDocType" : "ID_CARD",
      "country" : "ARG",
      "firstName" : "Franco Manuel",
      "lastName" : "Martinez",
      "number" : "12345678",
      "dob" : "1990-02-13",
      "address" : {
        "street" : "Corrientes",
        "state" : "Córdoba",
        "buildingNumber" : "1538",
        "town" : "Villa Carlos Paz",
        "postCode" : "X5152",
        "country" : "ARG"
      }
    },
    "residencyCheckInfo" : {
      "answer" : "GREEN",
      "nameMatch" : "GREEN",
      "addressMatch" : "GREEN",
      "numberMatch" : "GREEN",
      "dobMatch" : "GREEN",
      "crossCheckDetails" : {
        "detailsBreakdown" : [ {
          "source" : "GVT2",
          "name" : {
            "answer" : "GREEN",
            "firstName" : "GREEN",
            "firstInitial" : "GREEN",
            "lastName" : "GREEN"
          },
          "dob" : {
            "answer" : "IGNORED",
            "dayOfBirth" : "IGNORED",
            "monthOfBirth" : "IGNORED",
            "yearOfBirth" : "IGNORED"
          },
          "address" : {
            "answer" : "YELLOW",
            "street" : "GREEN",
            "buildingNumber" : "GREEN",
            "subStreet" : null,
            "town" : "IGNORED",
            "postCode" : null
          },
          "document" : {
            "answer" : "GREEN",
            "documentNumber" : "GREEN"
          }
        }, {
          "source" : "GVT1",
          "name" : {
            "answer" : "GREEN",
            "firstName" : "GREEN",
            "firstInitial" : "GREEN",
            "lastName" : "GREEN"
          },
          "dob" : {
            "answer" : "GREEN",
            "dayOfBirth" : "GREEN",
            "monthOfBirth" : "GREEN",
            "yearOfBirth" : "GREEN"
          },
          "address" : {
            "answer" : "GREEN",
            "street" : null,
            "buildingNumber" : "GREEN",
            "subStreet" : "IGNORED",
            "town" : "GREEN",
            "postCode" : null
          },
          "document" : {
            "answer" : "GREEN",
            "documentNumber" : "GREEN"
          }
        } ]
      }
    }
  } ]
}

Clarify rejection reason

For every rejection reason, we have a particular buttonId attached to the applicant or photo. To get a list of rejection reasons based on the applicant ID, use this API method.

Rejection typeValueRejection labelRejection reason
FINALdbNetReject_dataNotFoundDB_DATA_NOT_FOUNDThe data provided was not found.
FINALdbNetReject_dataMismatchDB_DATA_MISMATCHThe provided data does not match the data from the sources.
FINALdbNetReject_nameMismatchDB_DATA_MISMATCHThe provided name does not match the data from the sources.
FINALdbNetReject_addressMismatchDB_DATA_MISMATCHThe provided address does not match the data from the sources.
FINALdbNetReject_dobMismatchDB_DATA_MISMATCHThe provided date of birth does not match the data from the sources.

😀

Did you know?

When applicants skip or fail Non-Doc Address Verification, they can be moved to another flow for passing verification using documents.

Updated 3 months ago