Create user

Register a user with Push

POST /user

Try it

Create user

cURL

curl --request POST \
  --url https://api.pushcash.com/user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {
    "first": "Alfred",
    "last": "Hitchcock"
  },
  "email": "[e-mail]",
  "address": {
    "address_line_1": "1609 10th Ave",
    "locality": "Bodega Bay",
    "administrative_area": "CA",
    "postal_code": "94923",
    "country": "US"
  },
  "date_of_birth": "1899-08-13",
  "government_id": {
    "type": "passport",
    "last4": "7349"
  },
  "phone_number": "[phone]",
  "tag": "4c8e6b4f",
  "identity_verified": true
}
'

200

{
  "id": "<string>"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

The request format to create a user with Push

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

Example:

{ "first": "Alfred", "last": "Hitchcock" }

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

Example:

{
  "address_line_1": "1609 10th Ave",
  "locality": "Bodega Bay",
  "administrative_area": "CA",
  "postal_code": "94923",
  "country": "US"
}

email · string · required

The email address for the user

date_of_birth · string<date> · 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

Example:

{
  "type": "drivers_license",
  "last4": "Y7B9",
  "state": "OR"
}

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.

phone_number · string

The phone number for the user

tag · string

A tag or identifier to associate with the user object. We recommend setting this value to the id or primary key of the user database record.

Response

200

application/json

User created successfully

The response format for creating a user with Push

id · string · required

Push's identifier assigned to the user