Get User

Get logged user details

GET /v3/users/me

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
customer-token	string		Customer's authentication token
x-version-override	string		N/A

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.

200

{
    "data": {
        "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",
        "dateOfBirth": "1990-10-10",
        "spendingHold": false
    }
}

400

{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email [email protected]",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

Name	Type	Required	Description
data	object		N/A
data.userId	string		User Id
data.firstName	string		User's first name
data.lastName	string		User's last name
data.email	string		User's last name
data.createdAt	string		User's creation date
data.transactions	array		N/A
data.transactions[].id	string		Transaction Id
data.transactions[].createdAt	string		Transaction's creation date
data.transactions[].lease	object		N/A
data.transactions[].lease.id	string		lease identifier
data.transactions[].lease.status	string		N/A
data.decision	object		N/A
data.decision.applicationId	string		Application Id
data.decision.prequalId	string		prequalification ID
data.decision.approved	boolean		Determines if the customer was approved or not(To be deprecated)
data.decision.status	string		Determines the customer application status. Possible values: approved, pending, failed
data.decision.spendingLimit	number		The spending limit approved
data.decision.availableBalance	number		Available balance to spend
data.decision.availableWeeklySpending	number		The available amount to spend in a weekly basis
data.decision.createdAt	string		Decision's creation date
data.decision.waterfallSuppressionFlags	object		N/A
data.decision.waterfallSuppressionFlags.suppressWaterfallToUOwn	boolean		Determines if uown needs to be skipped)
data.decision.vantageHighScore	boolean		N/A
data.decision.funnel	string		N/A
data.verificationStatus	string		Verification status the possible status are: pending, failed, succeeded
data.dateOfBirth	string		User's date of birth
data.spendingHold	boolean		Determines if the customer spending was hold or not