Get a user

Retrieve a user by ID

Authorizations

Authorization

string

header

required

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

Path Parameters

id

string

required

The push identifier for the user

Response

200

application/json

successful operation

id

string

required

Push's identifier assigned to the user

tag

string | null

required

The tag provided in the request to create the user

status

enum<string>

required

Available options:

created,

enabled,

suspended,

disabled

name

object

required

The legal name of the user

Show child attributes

name.first

string

required

The person's given name

name.last

string

required

The person's family name

address

object

required

The address of the user's primary location

Show child attributes

address.address_line_1

string

required

The first line for the address

address.locality

string

required

The city or township

address.administrative_area

string

required

The state as a two-character code (e.g., CA, WA, TN, AL).

address.postal_code

string

required

The postal code, following the format XXXXX or XXXXX-XXXX.

address.country

string

required

The country

email

string

required

The email address for the user

phone_number

string | null

required

The phone number for the user

date_of_birth

string

required

The user's date of birth

government_id

object

required

Show child attributes

government_id.type

enum<string>

required

The type of government-issued ID

Available options:

drivers_license,

passport,

state_id,

military_id,

ssn

government_id.last4

string

required

The last 4 characters of the ID or number

government_id.state

string

The 2-letter code for the state in which the ID was issued. Only required if the ID is a driver's license or state ID.

Required string length: 2

payment_credentials

array | null

required

The payment credentials associated with the user

The details for the user's payment credential

Show child attributes

payment_credentials.bank_name

string

required

The name of the bank associated with the credential

payment_credentials.account

object

required

Show child attributes

payment_credentials.account.number_mask

string

required

The account number (mask)

payment_credentials.account.routing

string

required

The routing number for the account

payment_credentials.card

object

required

Show child attributes

payment_credentials.card.primary_account_number_mask

string

required

The primary account number (mask)

payment_credentials.card.expiration

string

required

The expiration date for the card

limits

object

required

The transaction limits for the user

Show child attributes

limits.daily_limit

integer

required

The daily transaction limit for the user (in the smallest currency unit).

limits.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

loyalty

object

required

Aggregated sportsbetting spending metrics for the user

Show child attributes

loyalty.deposit_count

integer

required

The number of sportsbetting deposits for the user

loyalty.deposit_volume

integer

required

The sum of sportsbetting deposits for the user in cents

loyalty.withdrawal_count

integer

required

The number of sportsbetting withdrawals for the user

loyalty.withdrawal_volume

integer

required

The sum of sportsbetting withdrawals for the user in cents

loyalty.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

loyalty.earliest_transaction_date

string

required

The date of the earliest transaction from which we aggregated deposits and withdrawals

loyalty.date

string

required

The aggregation date

created_at

string

required

Date and time in which user was first created in system