Update a travel document

patch

https://example.com/v1/profile/documents/{document_id}

Partially update a travel document by its stable Mercury UUID. Only include fields you want to change; omitted fields keep their current values. Null values return 422 (upstream provider cannot clear fields). Concurrent PATCHes are last-write-wins.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

document_id

uuid

required

Body Params

Partial update body for PATCH /v1/profile/documents/{id}.

All fields are optional. Only supplied fields override the existing
document; omitted fields retain their current values.

noExpiry / expiryDate rules (for this PATCH request):

noExpiry:true → clears the expiry date (document becomes permanent).
expiryDate must be omitted or null when noExpiry:true.
noExpiry:true + a real expiryDate → 422 (mutually exclusive).
expiryDate:null explicitly set without noExpiry:true
→ 422 (use noExpiry flag).

type

documentNumber

issueDate

expiryDate

noExpiry

boolean

Defaults to false

Set to true to clear the expiry date (mark document as permanent). Mutually exclusive with providing a real expiryDate.

issuingCountry

issuingCity

Responses

401

Missing or invalid authentication token

403

Provider refused the request (resolved deny)

404

Travel document not found

422

Validation failed

503

Travel documents service is temporarily unavailable

200Successful Response