ApplicantResource

Get applicant data

Changed on

Returns the data of a single applicant. The applicant is addressed in one of two ways:

1. By applicantId — GET /resources/applicants/{applicantId}/one (Get applicant data).

Example: /resources/applicants/5b594ade0a975a36c9349e66/one

2. By externalUserId — GET /resources/applicants/-;externalUserId={externalUserId}/one (Get applicant data by externalUserId).

Example: /resources/applicants/-;externalUserId=SomeExternalUserId/one

Both ways return the same response.

get/resources/applicants/{segment}/one

Request

  • Base URL: https://api.sumsub.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.sumsub.com/resources/applicants/{segment}/one
  • Auth: none declared

Path parameters

segmentstring required

The applicant to return, in one of two forms:

  • {applicantId} — unique applicant identifier in the Sumsub system, a random combination of 24 digits and lowercase Latin characters, generated when the applicant is created on the Sumsub side.
  • -;externalUserId={externalUserId} — unique applicant identifier as registered on your side.

Response

default response

Changes

    • warning

      added the new excessiveDots enum value to the // response property for the response status

    • warning

      added the new plusAddressing enum value to the // response property for the response status

    • warning

      added the new cipherOwl enum value to the //// response property for the response status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status