Verify Identity Document

POST

api

crew

identity-documents

{document_id}

verify

Verify Identity Document

curl --request POST \
  --url https://api.example.com/api/v1/crew/identity-documents/{document_id}/verify \
  --header 'Authorization: Bearer <token>'

{
  "targetType": "<string>",
  "targetId": "<string>",
  "rejectionReason": "<string>",
  "reviewedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

document_id

string<uuid>

required

Response

Successful Response

API response shape (camelCase). Used both as the per-item entry in a profile summary and embedded as the verification field on a credential response.

targetType

string

required

targetId

string

required

status

enum<string>

required

Per-item review state.

Available options:

not_submitted,

pending,

verified,

rejected

rejectionReason

string | null

reviewedAt

string<date-time> | null

Reject Identity DocumentOffice rejects an identity document with a reason.

Verify Identity Document

curl --request POST \
  --url https://api.example.com/api/v1/crew/identity-documents/{document_id}/verify \
  --header 'Authorization: Bearer <token>'

{
  "targetType": "<string>",
  "targetId": "<string>",
  "rejectionReason": "<string>",
  "reviewedAt": "2023-11-07T05:31:56Z"
}