Get a user

Retrieve a user by ID

GET /user/{id}

Try it

Get a user

cURL

curl --request GET \
  --url https://api.pushcash.com/user/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "user_28CJjV7P4Go5PNJvfzghiD",
  "tag": "4c8e6b4f",
  "status": "enabled",
  "name": {
    "first": "Alfred",
    "last": "Hitchcock"
  },
  "address": {
    "address_line_1": "1609 10th Ave",
    "locality": "Bodega Bay",
    "administrative_area": "CA",
    "postal_code": "94923",
    "country": "US"
  },
  "email": "[e-mail]",
  "phone_number": "[phone]",
  "date_of_birth": "1899-08-13",
  "government_id": {
    "type": "passport",
    "last4": "7349"
  },
  "payment_credentials": [
    {
      "bank_name": "Space Coast Credit Union",
      "account": {
        "number_mask": "5978",
        "routing": "263177903"
      },
      "card": {
        "primary_account_number_mask": "6018",
        "expiration": "2024-05-01"
      }
    }
  ],
  "limits": {
    "daily_limit": 1800000,
    "currency": "USD"
  },
  "created_at": "2023-04-10T05:10:14.532Z"
}

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

Example:

"user_28CJjV7P4Go5PNJvfzghiD"

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

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

Example:

"[e-mail]"

phone_number · string | null · required

The phone number for the user

Example:

"15559283950"

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"
}

payment_credentials · object[] | null · required

The payment credentials associated with the user

Show child attributes

payment_credentials. bank_name · string · required

The name of the bank associated with the credential

Example:

"Space Coast Credit Union"

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

Card details

Show child attributes

payment_credentials.card. primary_account_number_mask · string · required

The primary account number (mask)

payment_credentials.card. expiration · string<date> · required

The expiration date for the card

card_only_credentials · object[] | null · required

The card only credentials associated with the user

Show child attributes

card_only_credentials. primary_account_number_mask · string · required

The primary account number (mask)

card_only_credentials. expiration · string<date> · 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

created_at · string<date-time> · required

Date and time in which user was first created in system