Skip to main content
GET
Retrieve a document by external ID

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

externalId
string
required
Minimum string length: 1

Response

200 - application/json

OK

clientId
string<uuid>
required

Client ID

category
enum<string>
required

Category

Available options:
identity,
tax,
address,
incorporation,
financial,
other,
consent
scope
enum<string>
required

Scope

Available options:
MX,
US
type
string
required

Type

Minimum string length: 1
id
string<uuid>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
status
enum<string>
default:pending_upload

Status

Available options:
pending_upload,
uploaded,
pending_review,
processing,
verified,
rejected,
expired,
no_file
filename
string | null

Filename

contentType
string | null

Content Type

size
integer | null

Size

Required range: -9007199254740991 <= x <= 9007199254740991
expiresAt
string<date> | null

Expires At

verifiedAt
string<date-time> | null

Verified At

verifiedBy
string | null

Verified By

rejectionReason
string | null

Rejection Reason

reviewedAt
string<date-time> | null

Reviewed At

reviewedBy
string | null

Reviewed By

externalId
string | null

External ID

fields
object | null

Fields

metadata
object | null

Metadata