Skip to main content
POST
/realms/{realmId}/organizations/{organizationId}/travel/passengers

Authorizations

Authorization
string
header
required

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

Path Parameters

realmId
string
required
organizationId
string
required

Body

application/json
gender
enum<string>
required
Available options:
MALE,
FEMALE
phoneNumbers
string[]
required
Minimum array length: 1
Pattern: ^\d{10,15}$
address
object
required
userId
string

Identity user to LINK. When present, name/emails/documents.CPF are copied from the user (do not send them) and birthDate falls back to the user record. When absent, the body is a STANDALONE passenger and name/birthDate/emails/documents become required.

Minimum string length: 1
name
string

Required in standalone mode; read-only (omit) in linked mode.

Minimum string length: 1
birthDate
string

Required in standalone mode; in linked mode used only when the identity user has no birth date on record.

Pattern: ^\d{4}-\d{2}-\d{2}$
emails
string<email>[]

Required in standalone mode; read-only (omit) in linked mode.

Minimum array length: 1
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
documents
object

Required in standalone mode (at least one of CPF/RG/PASSPORT/CNH). In linked mode CPF comes from the user (do not send documents.CPF; an empty object is fine); extra documents may be added.

loyalty
object
customFields
object

Response

default

Undocumented response (no code type, no existing spec).