curl --request POST \
--url https://api.aura-app.ai/v1/lead-qualifications \
--header 'Content-Type: application/json' \
--data '
{
"consent_reference": "<string>",
"email": "jsmith@example.com",
"full_name": "<string>",
"answers": {},
"lead_id": "<string>",
"phone": "<string>",
"providers": [
"plaid",
"experian",
"equifax",
"transunion"
]
}
'import requests
url = "https://api.aura-app.ai/v1/lead-qualifications"
payload = {
"consent_reference": "<string>",
"email": "jsmith@example.com",
"full_name": "<string>",
"answers": {},
"lead_id": "<string>",
"phone": "<string>",
"providers": ["plaid", "experian", "equifax", "transunion"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
consent_reference: '<string>',
email: 'jsmith@example.com',
full_name: '<string>',
answers: {},
lead_id: '<string>',
phone: '<string>',
providers: ['plaid', 'experian', 'equifax', 'transunion']
})
};
fetch('https://api.aura-app.ai/v1/lead-qualifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aura-app.ai/v1/lead-qualifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'consent_reference' => '<string>',
'email' => 'jsmith@example.com',
'full_name' => '<string>',
'answers' => [
],
'lead_id' => '<string>',
'phone' => '<string>',
'providers' => [
'plaid',
'experian',
'equifax',
'transunion'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aura-app.ai/v1/lead-qualifications"
payload := strings.NewReader("{\n \"consent_reference\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"full_name\": \"<string>\",\n \"answers\": {},\n \"lead_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"providers\": [\n \"plaid\",\n \"experian\",\n \"equifax\",\n \"transunion\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aura-app.ai/v1/lead-qualifications")
.header("Content-Type", "application/json")
.body("{\n \"consent_reference\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"full_name\": \"<string>\",\n \"answers\": {},\n \"lead_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"providers\": [\n \"plaid\",\n \"experian\",\n \"equifax\",\n \"transunion\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aura-app.ai/v1/lead-qualifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"consent_reference\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"full_name\": \"<string>\",\n \"answers\": {},\n \"lead_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"providers\": [\n \"plaid\",\n \"experian\",\n \"equifax\",\n \"transunion\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"consent_reference": "<string>",
"created_at": "<string>",
"email": "<string>",
"full_name": "<string>",
"id": "<string>",
"latency_ms": 1,
"lead_id": "<string>",
"mode": "simulated",
"providers": [
{
"error_category": "<string>",
"latency_ms": 1,
"provider": "<string>",
"request_id": "<string>",
"signals": [
"<string>"
],
"status": "completed"
}
],
"qualification": "qualified",
"reasons": [
"<string>"
],
"route": "book_call",
"score": 50,
"status": "completed",
"tier": "A"
}{
"error": "<string>",
"message": "<string>",
"success": false,
"code": "<string>",
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"success": false,
"code": "<string>",
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}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.
curl --request POST \
--url https://api.aura-app.ai/v1/lead-qualifications \
--header 'Content-Type: application/json' \
--data '
{
"consent_reference": "<string>",
"email": "jsmith@example.com",
"full_name": "<string>",
"answers": {},
"lead_id": "<string>",
"phone": "<string>",
"providers": [
"plaid",
"experian",
"equifax",
"transunion"
]
}
'import requests
url = "https://api.aura-app.ai/v1/lead-qualifications"
payload = {
"consent_reference": "<string>",
"email": "jsmith@example.com",
"full_name": "<string>",
"answers": {},
"lead_id": "<string>",
"phone": "<string>",
"providers": ["plaid", "experian", "equifax", "transunion"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
consent_reference: '<string>',
email: 'jsmith@example.com',
full_name: '<string>',
answers: {},
lead_id: '<string>',
phone: '<string>',
providers: ['plaid', 'experian', 'equifax', 'transunion']
})
};
fetch('https://api.aura-app.ai/v1/lead-qualifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aura-app.ai/v1/lead-qualifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'consent_reference' => '<string>',
'email' => 'jsmith@example.com',
'full_name' => '<string>',
'answers' => [
],
'lead_id' => '<string>',
'phone' => '<string>',
'providers' => [
'plaid',
'experian',
'equifax',
'transunion'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aura-app.ai/v1/lead-qualifications"
payload := strings.NewReader("{\n \"consent_reference\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"full_name\": \"<string>\",\n \"answers\": {},\n \"lead_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"providers\": [\n \"plaid\",\n \"experian\",\n \"equifax\",\n \"transunion\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aura-app.ai/v1/lead-qualifications")
.header("Content-Type", "application/json")
.body("{\n \"consent_reference\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"full_name\": \"<string>\",\n \"answers\": {},\n \"lead_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"providers\": [\n \"plaid\",\n \"experian\",\n \"equifax\",\n \"transunion\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aura-app.ai/v1/lead-qualifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"consent_reference\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"full_name\": \"<string>\",\n \"answers\": {},\n \"lead_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"providers\": [\n \"plaid\",\n \"experian\",\n \"equifax\",\n \"transunion\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"consent_reference": "<string>",
"created_at": "<string>",
"email": "<string>",
"full_name": "<string>",
"id": "<string>",
"latency_ms": 1,
"lead_id": "<string>",
"mode": "simulated",
"providers": [
{
"error_category": "<string>",
"latency_ms": 1,
"provider": "<string>",
"request_id": "<string>",
"signals": [
"<string>"
],
"status": "completed"
}
],
"qualification": "qualified",
"reasons": [
"<string>"
],
"route": "book_call",
"score": 50,
"status": "completed",
"tier": "A"
}{
"error": "<string>",
"message": "<string>",
"success": false,
"code": "<string>",
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"success": false,
"code": "<string>",
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}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.Body
1 - 2001 - 200Show child attributes
Show child attributes
7 - 401 - 4 elementsplaid, experian, equifax, transunion Response
Qualification result
x >= 0Whether the provider results in this response came from real provider calls (live) or from the built-in simulator (simulated). The provider names are actual credit bureaus, so a completed result is otherwise indistinguishable from one. Branch on this rather than trusting providers[].status.
live, simulated "simulated"
Show child attributes
Show child attributes
qualified, review, unqualified, unverifiable book_call, nurture, manual_review, unverifiable 0 <= x <= 100completed, partial, failed A, B, C, review