/find_or_create_user

post

https://api.paynearme-sandbox.com/json-api/find_or_create_user

NOTE: Available only on sites set up with site user types (for example, for disbursements to push users). On other sites the API returns Unrecognized API Call.

Takes the same fields as create_user. If a user with this site_user_identifier already exists, the call updates that user with the fields you send and returns it, instead of failing as create_user does.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Finds the user with this site_user_identifier, or creates one

site_identifier

string

required

Defaults to S2411573363

Identifies your client site.

timestamp

string

required

The Unix Epoch time of the call

version

string

required

Defaults to 3.0

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

Defaults to ABC123

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

user_type

string

required

Defaults to push

Use push for push users.

first_name

string

required

Defaults to Johnny

The first name of the user.

middle_name

string

Defaults to Diego

The middle name of the user.

last_name

string

required

Defaults to Smith

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

Defaults to 1980

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

street

string

required

Defaults to 123 Fake Street

The street address of the user.

street2

string

The second line of the user's street address.

city

string

required

Defaults to Allen

The city of the user's address.

state

string

required

Defaults to TX

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

postal_code

string

required

Defaults to 75013

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

country

string

Defaults to US

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

Responses

200User Found or Created