Get Users

Get all users for a given vendor

GET /v3/users

Request

The details below help you form your HTTP requests to this endpoint.

Headers

You may need to provide specific headers.

Name
Type
Required
Description

x-consumer-custom-id

string

Consumer data with the format "channel:vendorId"

Query

You may provide query parameters to filter the output.

Name
Type
Required
Description

page

number

Page number to retrieve. Max 1000

limit

number

Limit of users to retrieve. Max 1000

Response

The details below help you understand the responses you could get from this endpoint.

Samples

Below are samples of responses, with tabs corresponding to returned status code.

{
    "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",
                    "prequalId": "5a319511a86980001d602095",
                    "approved": true,
                    "status": "approved",
                    "spendingLimit": 1300,
                    "availableBalance": 1200,
                    "availableWeeklySpending": 120,
                    "createdAt": "2018-03-19T15:51:27.080Z",
                    "waterfallSuppressionFlags": {
                        "suppressWaterfallToUOwn": false
                    },
                    "vantageHighScore": true,
                    "funnel": "tireagent"
                },
                "verificationStatus": "succeeded"
            }
        ],
        "meta": {
            "count": 1,
            "totalPages": 1,
            "page": 1,
            "limit": 20
        }
    }
}

Schema

The response's schema is outlined below.

Name
Type
Required
Description

data

object

N/A

data.users

array

N/A

data.users[].userId

string

User Id

data.users[].firstName

string

User's first name

data.users[].lastName

string

User's last name

data.users[].email

string

User's last name

data.users[].createdAt

string

User's creation date

data.users[].transactions

array

N/A

data.users[].transactions[].id

string

Transaction Id

data.users[].transactions[].createdAt

string

Transaction's creation date

data.users[].transactions[].lease

object

N/A

data.users[].transactions[].lease.id

string

lease identifier

data.users[].transactions[].lease.status

string

N/A

data.users[].decision

object

N/A

data.users[].decision.applicationId

string

Application Id

data.users[].decision.prequalId

string

prequalification ID

data.users[].decision.approved

boolean

Determines if the customer was approved or not(To be deprecated)

data.users[].decision.status

string

Determines the customer application status. Possible values: approved, pending, failed

data.users[].decision.spendingLimit

number

The spending limit approved

data.users[].decision.availableBalance

number

Available balance to spend

data.users[].decision.availableWeeklySpending

number

The available amount to spend in a weekly basis

data.users[].decision.createdAt

string

Decision's creation date

data.users[].decision.waterfallSuppressionFlags

object

N/A

data.users[].decision.waterfallSuppressionFlags.suppressWaterfallToUOwn

boolean

Determines if uown needs to be skipped)

data.users[].decision.vantageHighScore

boolean

N/A

data.users[].decision.funnel

string

N/A

data.users[].verificationStatus

string

Verification status the possible status are: pending, failed, succeeded

data.meta

object

N/A

data.meta.count

number

N/A

data.meta.totalPages

number

N/A

data.meta.page

number

N/A

data.meta.limit

number

N/A

Last updated

Was this helpful?