Skip to main content
POST
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.

Body

application/json
Required string length: 1 - 200
email
string<email>
required
full_name
string
required
Required string length: 1 - 200
answers
object
lead_id
string
phone
string
Required string length: 7 - 40
providers
enum<string>[]
Required array length: 1 - 4 elements
Available options:
plaid,
experian,
equifax,
transunion

Response

Qualification result

created_at
string
required
email
string
required
full_name
string
required
id
string
required
latency_ms
integer
required
Required range: x >= 0
lead_id
string | null
required
mode
enum<string>
required

Whether 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.

Available options:
live,
simulated
Example:

"simulated"

providers
object[]
required
qualification
enum<string>
required
Available options:
qualified,
review,
unqualified,
unverifiable
reasons
string[]
required
route
enum<string>
required
Available options:
book_call,
nurture,
manual_review,
unverifiable
score
integer
required
Required range: 0 <= x <= 100
status
enum<string>
required
Available options:
completed,
partial,
failed
tier
enum<string>
required
Available options:
A,
B,
C,
review