Validate User

The Validate User endpoint checks a customer's eligibility for leasing with a specific leasing provider. This helps ensure users meet the provider's leasing criteria before proceeding with offers.

Endpoint

GET /v1/leasingprovider/{leasingproviderslug}/validate-user/{identifier}

Parameters

• leasingproviderslug (string, required) The unique slug of the leasing provider, typically the provider's name in lowercase and without spaces or symbols. For example, "Deutsche Dienstrad" would be represented as deutschedienstrad. You can find the slug of a leasing provider that is available to your tenant in the Leasing Providers Endpoint section.

• identifier (string, required) The user's unique identifier, such as their email address or validation code. This will be used to check the user's eligibility status. Note that the kind of identifier you use depends on the provider. Jobrad, for example, requires an email address, while eurorad requires a validation code.

• x-api-key (string, required, header) Your API key for authenticating the request. For more information on API keys, see Authentication.

Response

Success Response (Status 200)

Returns a JSON object with the user's eligibility information.

Example Response

{
"leasingProviderSlug": "jobrad",
"identifier": "mustermitarbeiterin@gmx.net",
"isValid": true,
"validationMessage": "User found"
}

Response Fields

• leasingProviderSlug (string) The leasing provider's slug.

• identifier (string) The unique identifier used in the request, such as the user's email.

• isValid (boolean) Indicates whether the user is eligible (true) or not (false).

• validationMessage (string) Additional information about the validation result. This field is different for each provider. Possible values include User found, User not found, User has too many bikes, and so on.

Error Responses

• 400 Bad Request – Invalid parameters.

{
"error": "Invalid parameters"
}

• 401 Unauthorized – API key missing.

{
"error": "API key missing"
}

• 403 Forbidden – Invalid API key.

{
"error": "Invalid API key"
}

• 404 Not Found – Leasing provider or user not found.

{
"error": "Leasing provider or user not found"
}

Example Request

Here's a sample curl request to validate a user:

curl --location 'https://api.leasingautomation.de/v1/leasingprovider/jobrad/validate-user/mustermitarbeiterin%40gmx.net'
\
--header 'x-api-key: YOUR_API_KEY'

Interactive API Console

You can also explore and test each endpoint in our OpenAPI/Swagger interactive API console, which provides a hands-on way to examine request/response details in real time.