Apply document recognised by /recognise-document

post/session/{sessionId}/pax-session/{paxSessionId}/apply-document/recognised

Request

  • Base URL: https://api-docs.iberojet.com (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.iberojet.com/session/{sessionId}/pax-session/{paxSessionId}/apply-document/recognised
  • Auth: HTTP bearer

Path parameters

sessionIdstring required

MultiPax session id

paxSessionIdstring required

Pax session id (prefixed with 'pax_')

Headers

X-Request-Idstring

Request id to be returned in response header (auto generated if not specified)

Accept-Languagestring

Locale to return content with

Request body

documentsobject[] required

List of documents got from /recognise-document

document_typestring required

Document type recognised by /recognise-document

signaturestring required

Signature got from /recognise-document

method'MANUAL' | 'SCAN' | 'UPLOAD' required
is_travel_documentboolean required

Whether document applied is travel document - should match DocumentRequirement.is_travel_document from Checklist item

additional_pax_idsstring[] required

List of additional pax session ids to apply this document to (apart from main pax session id)

Response

Success (with updated Pax session) or Error (doc processing, id or rules mismatch)

Changes

No recorded changes to this operation across all 1 revision of this API.