Get End User

uuid

string

The End User’s UUID.

Example value:  eur_747536f4-1efd-4cad-91b3-cc8aaeed93e3

code

string

The End User’s code.

Example value:  ECSCDSVFGH

type

string

The type of end user. Whether a company or an individual.

Example value:  COMPANY

first_name

string

The user’s first name.

Example value:  John

last_name

string

The user’s last name.

Example value:  Smith

organization

string

The organization’s name.

Example value:  DRUO

local_id

string

The user’s ID number.

Example value:  45235553

local_id_type

string

The user’s ID type.

Example value:  NATIONAL_ID

local_id_country

string

The user’s citizenship in 3-letter ISO code.

Example value:  COL

date_of_birth

string

The user’s date of birth in YYYY-MM-DD format.

Example value:  2021-07-19

email

string

The user’s phone number.

Example value:  john.smith@gmail.com

phone_number

object

The user’s phone number.

Example Value:

"phone_number": {
    "country_code": 1,
    "number": 2025550198
}

address

Address

The user’s address.

Example Value:

"address": {
  "address_line_1": "1600 Pennsylvania Ave NW",
  "address_line_2": "Apt 101",
  "address_line_3": null,
  "locality": "Washington",
  "sublocality": null,
  "administrative_district": "DC",
  "postal_code": "20500",
  "country": "USA"
}

preferred_language

string

The user’s preferred language. Used for system notifications.

Example value:  en_US

note

string

A custom note associated with this end user.

Example value:  This is a special customer.

primary_reference

string

The End User’s primary reference. Can be any value to associate the end user to an entity in an external system.

Example value:  23423524

secondary_reference

string

The End User’s secondary reference. Can be any value to associate the end user to an entity in an external system.

Example value:  bj39fhow39fhqp3f0hfae4344

metadata

string

Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.

Example value:  {"order_id": "6735"}

creation_source

string

The channel through which the end user was created.

date_created_gmt

date-time

Create date of the end user

Example value:  2021-11-15T23:23:38Z

date_updated_gmt

date-time

Updated date of the end user

Example value:  2021-11-15T23:23:38Z