Get user personal info

Request

This endpoint gets user personal info by user ID.

Security

Bearer

Path

userIdstring, (uuid)required

Identifier for user.

Example:4974a66b-7493-4f41-908c-58ba81093947

Query

includeInactiveboolean

Include inactive users.

Default:false

Example:includeInactive=true

curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/personal-info?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

addressesArray of objects(PostalAddress)

dobobject(Date)

Date in ISO 8601 standard.

emailstring, (email)

Example:"example@email.com"

genderstring(Gender)

Enum:"MALE""FEMALE""UNSPECIFIED""UNDISCLOSED""GENDER_REDACTED"

Example:"FEMALE"

identityDocsArray of objects(IdentityDocument)

List of user identity documents.

Example:

[
  {
    "passport": { … }
  },
  {
    "ktn": { … }
  }
]

nameobject(Name)

Full name containing first, middle, last (family) names, and suffix.

phoneNumbersArray of objects(PhoneNumber)

profilePictureobject(Image)

An image with meta data. Either the data or url property must be supplied to load the image.

nationalitystring

Nationality of user

Example:"Indian"

titlestring(UserTitle)

Enum:"TITLE_UNKNOWN""MR""MS""MRS""MX""MASTER""MISS""DR""PROFESSOR""CAPTAIN"

Example:"MR"

preferredLanguagestring

Language preferred by user.

Example:"en-US"

preferredPronounstring(PreferredPronoun)

Pronoun preferred by user.

Enum:"SHE_HER_HERS""HE_HIM_HIS""THEY_THEM_THEIRS"

Example:"SHE_HER_HERS"

travelerNameobject(Name)

A name of user that does not contain special characters.

emergencyContactobject(EmergencyContact)

Emergency contact information.

emergencyContactInfoobject(EmergencyContactInfo)deprecated

Emergency contact information.

Response

{
  "addresses": [
    { … }
  ],
  "dob": {
    "iso8601": "2017-07-21"
  },
  "email": "example@email.com",
  "emergencyContactInfo": {
    "address": { … },
    "designation": "MANAGER",
    "email": "emergency-contact@email.com",
    "name": { … },
    "phoneNumber": { … },
    "userOrgId": { … }
  },
  "gender": "FEMALE",
  "identityDocs": [
    { … },
    { … }
  ],
  "name": {
    "family1": "Gandas",
    "family2": "FamilyTwo",
    "given": "Vichitr",
    "middle": "Kumar",
    "suffix": "SR",
    "preferred": "Don"
  },
  "phoneNumbers": [
    { … }
  ],
  "profilePicture": {
    "data": "6935813e12584abda0e43d71cd2ea260",
    "dimensions": { … },
    "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp",
    "metadata": { … }
  },
  "nationality": "Indian",
  "title": "MR",
  "preferredLanguage": "en-US",
  "preferredPronoun": "SHE_HER_HERS",
  "travelerName": {
    "family1": "Gandas",
    "family2": "FamilyTwo",
    "given": "Vichitr",
    "middle": "Kumar",
    "suffix": "SR",
    "preferred": "Don"
  },
  "emergencyContact": {
    "name": "John Smith",
    "email": "emergency-contact@email.com",
    "designation": "MANAGER",
    "relation": "SPOUSE",
    "phoneNumbers": [ … ],
    "preferredLanguage": "en-US"
  }
}