📘

Prerequisites

Review Accessing the API and Onboarding with Proof sections first.

authID Identity Verification Best Practices

For developers with existing user document images stored in their system, authID identity verification provides a solution to implement the new identity verification process for their user base.

While authID identity verification best practices recommend using the original document and corresponding document owner, an alternative workflow allows developers to submit previously captured document images on behalf of users.

The integration pattern follows the process outlined in Onboarding with authID identity verification, with one exception: instead of displaying the Proof User Interface, developers must submit the document using the Document Processing API. This distinction is shown in the accompanying diagrams.

User-driven Identity Verification

Document Upload via API

Backend Document Processing API

Reference documentation for Document Processing API is available here.

Security

The API call requires the following security elements:

• HTTP Authorization header with bearer access token as described in API Authentication and Security section.
• Proof Operation Id / Secret

🚧

User roles

The Transaction Data Provider role is required to invoke this API.

Developers will receive an HTTP 403 error code if this role is missing from the access token.

Input Data

The developer must provide:

• An image of the front side of the document (SideA).
• Optionally, an image of the back side of the ID card or an additional passport page (SideB).
• Optionally, a user image as a selfie.

Acceptable data types include JPEG, PDF, and PNG, with a maximum payload size of 10MB.

Example

curl -X 'POST' \
  'https://id.authid.ai/ForeignCapture/Submit' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer eyJhbGNRSI...B3iHSfKE1Ypw' \
  -H 'Content-Type: multipart/form-data' \
  -F 'OneTimeSecret=xIkVbRZRtKaNIqJXufAWvdeP' \
  -F 'OperationId=feddacc8-8739-5f3d-cc9e-7db0fb6f9023' \
  -F 'SideA=@US_PASSPORT.jpg;type=image/jpeg' \
  -F 'SideB=' \
  -F 'Selfie='