Deeply Verify User Exists

Verifies whether FlexShopper already has record of a user with the given parameters.

This endpoint performs a more comprehensive user existence check than Verify User Exists. It does so by verifying that a user record exists in our system and that the user has a phone number and address matching the given parameters.

We standardize the incoming and the on-file addresses before attempting to match them.

Request

POST /user/exists

Request Body

NameTypeRequiredDescription

email

string

Customer's e-mail address

phone

string

Customer's phone number

address

object

Customer's address

address.street1

string

"Street 1" of customer address

address.street2

string

"Street 2" of customer address

address.city

string

City of customer address

address.region

string

Region of customer address

address.postalCode

string

Postal code of customer address

address.country

string

Country of customer address

Headers

NameTypeDescription

Authorization

string

Authorization token

Response

A successful response should have a status code of 200.

The response data's schema is as follows:

Key

Type

Description

emailExists

boolean

True if a user record exists with the given email

phoneExists

boolean

True if the found user has matching phone

addressExists

boolean

True if the found user has matching address

Sample

{
  "data": {
    "emailExists": true,
    "phoneExists": true,
    "addressExists": false
  }
}

Last updated