API ReferenceChangelogFAQDashboard

Get started with address verification

Start conducting effective address verification with the Non-Doc solution.

To start using Non-Doc address verification, you can opt for:

📘

Note

Non-Doc address verification comes at an additional cost regardless of the integration method. Make sure to contact us before starting the integration.

Verify address via Web and Mobile SDKs

Use our Web and Mobile SDKs to conduct Non-Doc address verification code-free:

  1. Set up the integration, as described in the WebSDK integration article and MobileSDK integration article.
  2. Create a verification level, add an Applicant data verification step, and submit the data as per table references.
  3. Conduct verification and handle verification results.

Use Sumsub API

You can utilize our public API endpoints to conduct address verification using the Non-Doc solution:

  1. Create a verification level with an Applicant data step.
  2. Include the Required fields as specified in the table and add Recommended/Optional fields to increase the positive impact on pass rates.
  3. Create an applicant and pass the level name created at step 1 as the levelName query parameter.
curl -X POST \
    'https://api.sumsub.com/resources/applicants?levelName=global-address-verification' \
    -H 'Content-Type: application/json' \
    -d '{
          "externalUserId": "someUniqueUserId",
          "metadata": [
            {
              "key": "documentNumber",
              "value": "12345678A"
            }
          ],
          "fixedInfo": {
            "firstName": "John",
            "lastName": "Doe",
            "dob": "1990-01-01",
            "country": "ESP",
            "phone": "+34 123 456 789",
            "addresses": [
              {
                "street": "C. Ramon J Sender",
                "buildingNumber": "7A",
                "town": "Cartagena",
                "state": "Murcia",
                "postCode": "30204",
                "country": "ESP"
              }
            ]
          }
        }'

{
  "id" : "65dc83fb0ef8657a162ec3de",
  "createdAt" : "2024-02-26 12:28:43",
  "key" : "DGATQKRNEXWUCD",
  "clientId" : "kidtest_2",
  "inspectionId" : "65dc83fb0ef8657a162ec3df",
  "externalUserId" : "2345321qer",
  "info" : { },
  "fixedInfo" : {
    "firstName" : "John",
    "lastName" : "Doe",
    "dob" : "1990-01-01",
    "country" : "ESP",
    "phone" : "+34 123 456 789",
    "addresses" : [ {
      "street" : "C. Ramon J Sender",
      "state" : "Murcia",
      "buildingNumber" : "7A",
      "town" : "Cartagena",
      "postCode" : "30204",
      "country" : "ESP",
      "formattedAddress" : "C. Ramon J Sender, 7A, Cartagena, Murcia, Spain, 30204"
    } ]
  },
  "applicantPlatform" : "API",
  "requiredIdDocs" : {
    "includedCountries" : [ "AUS", "AUT", "BEL", "CAN", "CHN", "DEU", "DNK", "ESP", "FIN", "FRA", "ITA", "NLD", "PRT", "SWE", "GBR" ],
    "docSets" : [ {
      "idDocSetType" : "APPLICANT_DATA",
      "fields" : [ {
        "name" : "firstName",
        "required" : true
      }, {
        "name" : "middleName",
        "required" : false
      }, {
        "name" : "lastName",
        "required" : true
      }, {
        "name" : "dob",
        "required" : false
      }, {
        "name" : "country",
        "required" : true
      }, {
        "name" : "street",
        "required" : true
      }, {
        "name" : "subStreet",
        "required" : false
      }, {
        "name" : "state",
        "required" : false
      }, {
        "name" : "town",
        "required" : false
      }, {
        "name" : "postCode",
        "required" : true
      }, {
        "name" : "phone",
        "required" : false
      }, {
        "name" : "tin",
        "required" : false
      } ],
      "customFields" : [ {
        "name" : "documentNumber",
        "displayName" : "National ID Number",
        "required" : false
      } ]
    } ]
  },
  "review" : {
    "reviewId" : "vnmMj",
    "attemptId" : "WokaV",
    "attemptCnt" : 0,
    "levelName" : "ePOA",
    "levelAutoCheckMode" : null,
    "createDate" : "2024-02-26 12:28:43+0000",
    "reviewStatus" : "init",
    "priority" : 0
  },
  "type" : "individual",
  "metadata" : [ {
    "key" : "documentNumber",
    "value" : "1234567"
  } ],
  "inspectionMetadata" : [ ]
}

🚧

Important

Pay attention to the following fields from the table reference:

  • The National ID number must be provided in the metadata as the documentNumber field. 
    "metadata": [
  {
    "key": "documentNumber",
    "value": "12345678A"
  }
]
  • The Tax Identification number must be provided as TIN in the .fixedInfo object.
  1. Request an applicant check.
curl -X POST \
  'https://api.sumsub.com/resources/applicants/5b73b82f0a975a3b46429758/status/pending'

{
  "ok": 1
}
  1. Handle verification results.

Fallback to standard verification

In case something goes wrong during Non-Doc Verification or you just want to verify applicants using the standard document verification approach:

  • For SDKs, use the Workflow Builder to configure the verification flow as necessary.
  • For the API, If you already have a complex logic on your side, move the applicants to a desired level by using this API request.

Updated about 1 month ago