OpenapiV1Lead qualifications
Qualify a lead (preview)
Preview endpoint. Read this before integrating.
Unless LEAD_QUALIFY_MODE=real is configured server-side — it is not, in any
environment today — this endpoint returns simulated results. No credit
bureau is contacted, despite plaid, experian, equifax and
transunion appearing in the request and in providers[].provider. The
per-provider request_id values are generated locally, and the decision is
derived from the request body alone.
Check the response's mode field: simulated means no provider was
called. Do not present a simulated result to an end user as a verification
outcome.
Nothing is persisted — this endpoint writes no record and returns no id you can look up later.
Requires the write scope.
answers?
Default
{}consent_referencestring
Length
1 <= length <= 200emailstring
Format
emailfull_namestring
Length
1 <= length <= 200lead_id?string
phone?string
Length
7 <= length <= 40providers?array<string>
Default
["plaid","experian","equifax","transunion"]Items
1 <= items <= 4Response Body
application/json
application/json
application/json
curl -X POST "https://api.aura-app.ai/v1/lead-qualifications" \ -H "Content-Type: application/json" \ -d '{ "consent_reference": "string", "email": "user@example.com", "full_name": "string" }'{
"consent_reference": "string",
"created_at": "string",
"email": "string",
"full_name": "string",
"id": "string",
"latency_ms": 0,
"lead_id": "string",
"mode": "simulated",
"providers": [
{
"error_category": "string",
"latency_ms": 0,
"provider": "string",
"request_id": "string",
"signals": [
"string"
],
"status": "completed"
}
],
"qualification": "qualified",
"reasons": [
"string"
],
"route": "book_call",
"score": 100,
"status": "completed",
"tier": "A"
}{
"code": "string",
"error": "string",
"message": "string",
"requestId": "string",
"success": false
}{
"code": "string",
"error": "string",
"message": "string",
"requestId": "string",
"success": false
}