TravelerDocument

Response Model for Traveler Document

This is the representation of the TravelerDocument data structure which you receive in the Traveler API response.

{
    "id": "9ffea851-3d79-4ae9-bb3a-3ffd782e66f8",
    "firstName": "Jon",
    "lastName": "Snow",
    "gender": "male",
    "email": "jon.snow@gmail.com",
    "hometown": {
      "city": "Sydney",
      "country": "Australia"
    },
    "savatar": {
      "url": "https://image.com/savatar.jpg",
      "publicId": "traveler/9387347653783/savatar"
    },
    "mavatar": {
      "url": "https://image.com/mavatar.jpg",
      "publicId": "traveler/9387347653783/mavatar"
    }
  }

Property

Type

Required

Description

id

string

Y

The ID of the traveler in Goki.

firstName

string

Y

First name of the traveler.

lastName

string

Y

Last name of the traveler.

gender

string

Y

Gender of the traveler. Can be male or female.

email

string

Y

The email address of the traveler.

homeTown

object

N

An object containing the home country and city of the traveler.

savatar

object

N

Traveler avatar in small size.

mavatar

object

N

Traveler avatar in medium size.

Last updated