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

# POST /get_user

`POST /get_user`

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

## Request body

- union — Finds the specified user record
  - object
    - `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, required — 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.
    - `site_user_identifier` string, required — The unique, client-defined ID of the person receiving the disbursement funds.
  - object
    - `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, required — 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.
    - `pnm_user_identifier` string, required — A unique, PayNearMe-defined string ID for the person receiving the disbursement funds.

## Response `201`

User Found

- 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.

---

[API](https://skmtc.net/paynearme/apis/paynearme-api-v3-0.md) · [All operations](https://skmtc.net/paynearme/apis/paynearme-api-v3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paynearme/paynearme-api-v3-0/revisions/44cba4f8b80f/schema)