Account Lookup

Search for users that already have a FlexShopper account.

Users Search

POST https://apis.sandbox.flexshopper.com/v3/users/search

This endpoint allows you to access user accounts by providing PII.

Headers

Name	Type	Description
Authorization	string	Authorization token.

Request Body

Name	Type	Description
mobilePhone	string	Consumer's mobile phone (no parantheses or dashes)
ssn	string	Consumer's Social Security Number

200 Cake successfully retrieved.

{    
    "data": {
        "users": [
            {
              "userId": "1234-asdf-4321-fdsa",
              "firstName": "John",
              "lastName": "Doe",
              "email": "Doe",
              "createdAt": "2018-03-19T15:51:27.080Z",
              "transactions": [
                {
                     "id": "asdf-1234-fdsa-4321",
                     "createdAt": "2018-12-21",
                     "lease": {
                        "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
                        "status": "signed"
                     }
                }
             ],
            "decision": {
                "applicationId": "d363955e-3110-11e8-a373-5e7783c1a76e",
                "approved": true,
                "status": "approved",
                "spendingLimit": 1300,
                "availableBalance": 1200,
                "availableWeeklySpending": 120,
                "createdAt": "2018-03-19T15:51:27.080Z"
            },
            "verificationStatus": "succeeded",
            "cardVerified": false, 
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YTk..." 
        }
        ],
         "meta": {
            "count": 1,
            "totalPages": 1,
            "page": 1,
            "limit": 20
        }
    }
}

404 No matching users.

{
  "data": {
    "users": [],
    "meta": {
      "limit": 1,
      "page": 1
    }
  }
}