Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
Users

Find a user record using either the <code>site_user_identifier</code> or the <code>pnm_user_identifier</code>.

post/get_user

Request body

OR

Example request

{
  "site_user_identifier": "99999999"
}

Response

User Found

user_typestring

push

push_user_identifierstring

The unique, client-defined ID of the person receiving the disbursement funds.

pnm_user_identifierstring

A unique, PayNearMe-defined string ID for the person receiving the disbursement funds.

push_user_status'not_validated' | 'ok_to_receive'

Indicates whether or not the user has been validated and can receive funds.

push_first_namestring

The first name of the user.

push_middle_namestring

The middle name of the user.

push_last_namestring

The last name of the user.

push_full_namestring

The first and last name of the user.

push_streetstring

The street address of the user.

push_citystring

The city of the user's address.

push_statestring

The 2-character state of the user's address.

push_postal_codestring

The 5- or 9-digit ZIP code of the user's address.

push_countrystring

The 2-character country code of the user's address.

push_year_of_birthstring

The user's year of birth in YYYY format.

push_pre_verifiedstring

Pass <code>true</code> to indicate if the user's information was pre-verified for a disbursement payment.

push_manually_verifiedstring

Pass <code>true</code> to indicate if the client manually verified the user's information for a disbursement payment.

Example response

{
  "user_type": "push",
  "push_user_identifier": "88885555",
  "push_user_status": "ok_to_receive",
  "push_first_name": "John",
  "push_middle_name": "Diego",
  "push_last_name": "Smith",
  "push_full_name": "John Smith",
  "push_street": "123 Fake Street",
  "push_city": "Allen",
  "push_state": "TX",
  "push_postal_code": "75013",
  "push_country": "US",
  "push_year_of_birth": "1980",
  "push_pre_verified": "false",
  "push_manually_verified": "false"
}