Skip to main content
POST
/
api
/
v1
/
crew
/
users
/
{user_id}
/
identity-documents
Create Identity Document
curl --request POST \
  --url https://api.example.com/api/v1/crew/users/{user_id}/identity-documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentNumber": "<string>",
  "issuingCountry": "<string>",
  "issueDate": "2023-12-25",
  "expiryDate": "2023-12-25",
  "uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notes": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentType": "<string>",
  "uploadedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "documentNumber": "<string>",
  "issuingCountry": "<string>",
  "issueDate": "2023-12-25",
  "expiryDate": "2023-12-25",
  "uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "verification": {
    "targetType": "<string>",
    "targetId": "<string>",
    "rejectionReason": "<string>",
    "reviewedAt": "2023-11-07T05:31:56Z"
  },
  "notes": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
user_id
string<uuid>
required

Body

application/json

Create payload — after a file is uploaded via the upload service, the client posts metadata referencing the resulting upload_id.

​
documentType
enum<string>
required

Sub-type discriminator within identity documents.

Available options:
passport,
us_visa,
seaman_book,
national_id
​
documentNumber
string | null
​
issuingCountry
string | null
​
issueDate
string<date> | null
​
expiryDate
string<date> | null
​
uploadId
string<uuid> | null
​
notes
string | null

Response

Successful Response

API response shape with computed status.

​
id
string<uuid>
required
​
documentType
string
required
​
uploadedByUserId
string<uuid>
required
​
status
enum<string>
required

Computed at response time from expiry_date - today().

No unknown value — when there's no expiry_date we use VALID (the document doesn't expire; treat as good).

Available options:
valid,
expiring_soon,
expired
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
documentNumber
string | null
​
issuingCountry
string | null
​
issueDate
string<date> | null
​
expiryDate
string<date> | null
​
uploadId
string<uuid> | null
​
verification
CrewVerificationResponseDTO · object

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.

​
notes
string | null