Users

POST /change_user

Changed on

Change the details of an unverified user record.

Request

  • Base URL
    https://api.paynearme-sandbox.com/json-api
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://login.paynearme.com/oauth/token
    • or API key in query parameter signature

Request body

site_identifierstring required

Identifies your client site.

timestampstring required

The Unix Epoch time of the call

versionstring required

The version of the API. This version must match the version associated with your API key pair.

signaturestring

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

NOTE: This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.

site_user_identifierstring required

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

first_namestring required

The first name of the user.

middle_namestring

The middle name of the user.

last_namestring required

The last name of the user.

second_last_namestring

If applicable, the hyphenated second last name of the user.

year_of_birthstring required

The user's year of birth in YYYY format.

do_verificationstring

Indicates whether or not PayNearMe should perform an identity verification on the provided user information. If you have already verified the user's identity, submit this parameter as <code>false</code>.

streetstring required

The street address of the user.

street2string

The second line of the user's street address.

citystring required

The city of the user's address.

statestring required

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

postal_codestring required

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

countrystring

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

Response

User Record Changed

OR

Example response

{
  "status": "ok",
  "user": {
    "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"
  }
}

Changes

    • breaking

      removed the success response with the status

    • info

      api operation id change_user was added

    • info

      the request property signature became optional

    2 more changes in this revision