Get ID verification results
Request
- Base URLhttps://api.sumsub.com
- AuthAPI key in header X-App-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Unique identifier of the applicant 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.
Query parameters
Set to true to return data only from approved documents.<br><br>If omitted or set to false, the method returns data recognized from all documents of the approved applicant, not just the approved ones.
When true, includes deactivated (deleted) document images in the response and returns all matching image IDs for each (idDocType, country) pair, sorted by addedDate in descending order.<br><br>If omitted or set to false, deactivated (deleted) images are excluded from the response.
Changes
No recorded changes to this operation across all 2 revisions of this API.