Sign in

v1

latestOpenAPI 3.1.02026-07-241460559.8 KB

Get applicant data

get/resources/applicants/{applicantId}/one

Path parameters

applicantIdstring required

Unique applicant identifier in the Sumsub system. <br><br>This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the Dashboard. <br><br>If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

Response

200

OR

Example response

{
  "id": "5ecfbe9ad5ea48743f8dd1b8",
  "createdAt": "2020-05-28 13:37:30",
  "clientId": "coolclientid",
  "inspectionId": "5ecfbe9ad5ea48743f8dd1b9",
  "externalUserId": "externalCompanyId",
  "info": {
    "companyInfo": {
      "companyName": "Cool_company_name",
      "registrationNumber": "5555555",
      "country": "GBR",
      "legalAddress": "Street 123, London, England",
      "incorporatedOn": "2018-02-28 00:00:00",
      "applicantPosition": "Secretary",
      "type": "ltd",
      "email": "email@email.com",
      "phone": "(020) 0000 3333",
      "taxId": "55555276F",
      "registrationLocation": "UK Company Registration",
      "website": "www.website_name.com",
      "postalAddress": "10 St John Axe, London DT7R 00F",
      "noUBOs": true,
      "noShareholders": true,
      "beneficiaries": [
        {
          "applicantId": "5ecfbecad5ea48743f8dd438",
          "positions": [
            "director"
          ],
          "type": "ubo"
        }
      ]
    }
  },
  "requiredIdDocs": {
    "docSets": [
      {
        "idDocSetType": "COMPANY",
        "types": [
          "COMPANY_DOC"
        ],
        "steps": [
          {
            "name": "company",
            "minDocsCnt": 1,
            "idDocTypes": [
              "COMPANY_DOC"
            ]
          }
        ]
      }
    ]
  },
  "review": {
    "elapsedSincePendingMs": 308656,
    "elapsedSinceQueuedMs": 26993,
    "reprocessing": true,
    "createDate": "2020-05-29 12:22:11+0000",
    "reviewDate": "2020-05-29 12:27:19+0000",
    "startDate": "2020-05-29 12:26:52+0000",
    "reviewResult": {
      "reviewAnswer": "GREEN"
    },
    "reviewStatus": "completed"
  },
  "lang": "en",
  "type": "company"
}