---
title: "POST /change_user"
method: POST
path: "/change_user"
tags: ["Users"]
---

# POST /change_user

`POST /change_user`

## Request

- Base URL: `https://api.paynearme-sandbox.com/json-api`
- URL: `https://api.paynearme-sandbox.com/json-api/change_user`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://login.paynearme.com/oauth/token`
  - API key in query parameter `signature`

Change the details of an unverified user record.

## Request body

- ChangeUser: Changes an unverified user record
  - `site_identifier` string, required: Identifies your client site.
  - `timestamp` string, required: The Unix Epoch time of the call
  - `version` string, required: The version of the API. This version must match the version associated with your API key pair.
  - `signature` string: 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_identifier` string, required: The unique, client-defined ID of the person receiving the disbursement funds.
  - `first_name` string, required: The first name of the user.
  - `middle_name` string: The middle name of the user.
  - `last_name` string, required: The last name of the user.
  - `second_last_name` string: If applicable, the hyphenated second last name of the user.
  - `year_of_birth` string, required: The user's year of birth in YYYY format.
  - `do_verification` string: 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>.
  - `street` string, required: The street address of the user.
  - `street2` string: The second line of the user's street address.
  - `city` string, required: The city of the user's address.
  - `state` string, required: The 2-character state of the user's address.
  - `postal_code` string, required: The 5- or 9-digit ZIP code of the user's address.
  - `country` string: The 2-character country code of the user's address.

## Response `200`

User Record Changed

- union
  - object
    - `status` 'ok', required
    - `user` User: The User object only displays for disbursement orders and contains a listing of all users created for the disbursement.
      - `user_type` string: push
      - `push_user_identifier` string: The unique, client-defined ID of the person receiving the disbursement funds.
      - `pnm_user_identifier` string: 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_name` string: The first name of the user.
      - `push_middle_name` string: The middle name of the user.
      - `push_last_name` string: The last name of the user.
      - `push_full_name` string: The first and last name of the user.
      - `push_street` string: The street address of the user.
      - `push_city` string: The city of the user's address.
      - `push_state` string: The 2-character state of the user's address.
      - `push_postal_code` string: The 5- or 9-digit ZIP code of the user's address.
      - `push_country` string: The 2-character country code of the user's address.
      - `push_year_of_birth` string: The user's year of birth in YYYY format.
      - `push_pre_verified` string: Pass <code>true</code> to indicate if the user's information was pre-verified for a disbursement payment.
      - `push_manually_verified` string: Pass <code>true</code> to indicate if the client manually verified the user's information for a disbursement payment.
  - ErrorEnvelope: Returned with HTTP 200 for every failure except a rejected OAuth 2.0 access token, which returns HTTP 401 with the same shape. Every response carries a status; on failure it is "error" and the errors array describes what went wrong.
    - `status` 'error', required
    - `errors` ErrorDetail[], required: One entry per failure.
      - `description` string, required: Human-readable description of the failure.
      - `message` string: Parameter-validation detail (APPS-17178).
      - `receipt` string: Receipt text, where the failure relates to a payment.
      - `format` string: Expected format, for parameter-validation failures.
      - `example` string: Example of a well-formed value.
      - `details` object: Processor response details (APPS-18223).

## Other responses

- `401`: OAuth 2.0 requests only. The `Authorization` header has no Bearer token, the access token is invalid, expired, or issued for a different site, or the `site_identifier` does not match any site. The response does not say which. If the request is rejected before it reaches PayNearMe, the body may not be JSON, so detect this error by the HTTP status. HMAC-signed requests never receive this status.

## Changes

- **2026-11-03** `907541f733a3`: 1 breaking, 4 info
  - removed the success response with the status `201`
  - api operation id `change_user` was added
  - the request property `signature` became optional
  - added the non-success response with the status `401`
  - …1 more

[Operation history](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/changes/change_user/post.md)

---

[API](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0.md) - [All operations](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/llms.txt) - [OpenAPI document](https://skmtc.dev/paynearme/apis/paynearme-api-v3-0/revisions/907541f733a3?raw)
