post https://sandbox.treeforttech.com/api/verification/id-images
This endpoint is used to retrieve the ID document images and selfie image related to a client's Treefort ID verification report.
Response Schema
| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | Standard HTTP response code. Status codes are outlined in the Errors section of this API reference. |
| message | String | A human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference. |
| data | Array of Objects | An array of ID document / image information that the client uploaded during the ID verification process will be returned. For each image uploaded by the client, the following key information will be available: documentType: the type of image or document returned (e.g., Id, Image of Individual, Second ID Document - page 1, Second ID Document - page 2). originalDocumentType: the type of document uploaded by the client (e.g., PASSPORT, DRIVING_LICENSE, etc.). See the Accepted Document Types reference for a list of accepted document types and the short codes that may be returned. issuingCountry: if available, the issuing country of the ID document in 3166-1 alpha-3 format (e.g., CAN, USA, etc.). captureMethod: identifies how the image was captured (e.g., CAMERA for ID document images or SELFIE for the selfie image of the client). imageBase64: A Base64 encoded image of the ID document or selfie. isSecondaryId: if clients are required to upload a secondary ID as per your organization settings and the ID uploaded by the client is the client's secondary ID document, this will return true. A maximum of 1 primary and 1 secondary ID document may be uploaded by the client during the ID verification process. Please Note: certain documents (e.g., driver's licenses) require an image of both the front and back of the ID document and therefore 2 objects may be returned for a single ID document uploaded. createDate: the time stamp that the image was uploaded by the client. documentNumber: the document number of the ID document that was uploaded by the client, if available. documentExpiryDate: the expiry date of the ID document that was uploaded by the client, if available. issuingAuthority: the issuing jurisdiction of the ID document uploaded (e.g., issuing province, state, city, etc.), if available. |
| errors | Array of Strings | An array of human-readable error messages, if available (null otherwise). Unique errors associated with this endpoint, if applicable, are shown in the example response in the right column with the corresponding HTTP status code. |