POST
/
user
curl --request POST \
  --url https://api.pushcash.com/user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '{
  "name": {
    "first": "Alfred",
    "last": "Hitchcock"
  },
  "email": "alfred@imdb.com",
  "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": "(555) 681-3485",
  "tag": "4c8e6b4f",
  "identity_verified": true
}'
{
  "id": "<string>"
}

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
Example:

"f1bbb856-fb17-11ed-be56-0242ac120002"

Body

application/json

The request format to create a user with Push

​
name
object
required

The legal name of the user

Example:
{ "first": "Alfred", "last": "Hitchcock" }
​
address
object
required

The address of the user's primary location

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
required

The user's date of birth

​
government_id
object
required
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 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
User created successfully

The response format for creating a user with Push

​
id
string
required

Push's identifier assigned to the user