Start a detection
Verify one document.
Supply the document with source_url or with upload_id, but not with
both. The API answers before the analysis starts. Read the verdict from
GET /v1/detection/{detection_id}.
A source_url that the API cannot download makes this request fail with
422. The API downloads the URL during the request, so a slow host makes
a slow answer.
Send the header X-Sample-Run: true to make the run non-billable. That
header needs the scope DocumentVerification:detections:create_sample. Sample documents are limited per end customer by your contract; see Billing and confirm your allowance with Trelent.
Scope: DocumentVerification:detections:create
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
One document, named either by upload id or by a URL the API fetches.
The type of document that you expect.
passport, id_card, paystub, benefit_statement, bank_statement The jurisdiction that issued the document.
US, CA, BR The prefix uploads/<upload_id>/ that already holds exactly one file. Use this field only if you write to object storage yourself. Give either this field or source_url, but not both.
^[A-Za-z0-9-]+$An http or https URL that the API downloads. A presigned URL is acceptable. The API does not keep the URL. The document must be 50 MB or less, and must be a PDF, PNG, JPEG, TIFF, or WebP file.
The owner of this detection. Give the identifier of your end user to keep the detections of your users separate. The API uses your OAuth client if you omit this field.
Response
The detection is queued.
The receipt for a new detection. The verdict is not ready yet.