API Reference
  1. Mercury API
  2. Profile

Create a travel document

post
https://example.com/v1/profile/documents

Create a new travel document for the authenticated traveler.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for POST /v1/profile/documents.

Fields match what the Flow mobile form sends today
(apps/mobile/src/screens/app/travel-documents.tsx submitCreate).
isPrimary is intentionally absent — the Flow form does not collect it.

string
required

Document type enum value.

string
required

ISO date YYYY-MM-DD.

ISO date YYYY-MM-DD. Required unless noExpiry is true. Mutually exclusive with noExpiry:true.

boolean
Defaults to false

Set to true to explicitly mark the document as having no expiry date. When true, expiryDate must be omitted or null. When false (default), expiryDate is required.

string
required

ISO 3166-1 alpha-2 country code.

Responses

401

Missing or invalid authentication token

403

Provider refused the request (resolved deny)

422

Validation failed

503

Travel documents service is temporarily unavailable

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?