Create user

Register a user with Push

Authorizations

Authorization

string

header

required

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

Headers

X-Idempotency-Key

string

required

The idempotency key for the request

Maximum length: 255

Body

application/json

The request format to create a user with Push

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.administrative_area

string

required

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

address.country

string

required

The country

address.locality

string

required

The city or township

address.postal_code

string

required

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

date_of_birth

string

required

The user's date of birth

email

string

required

The email address for the user

government_id

object

required

Show child attributes

government_id.last4

string

required

The last 4 characters of the ID or number

government_id.type

enum<string>

required

The type of government-issued ID

Available options:

drivers_license,

passport,

state_id,

military_id,

ssn

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

identity_verified

boolean

required

Indicates whether the user's identity has been verified by the operator. For use-cases where KYC is required, this field must be set to true.

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

phone_number

string

The phone number for the user

tag

string

A tag to associate with the user for the purposes of reconciliation. For example, you can use this field to store your own internal ID for the user.

Response

200 - application/json

The response format for creating a user with Push

id

string

required

Push's identifier assigned to the user