POST /v1/screening/* call that needs only an API key and a phone number.
All three checks:
- Are standalone by default. No workflow or session is required; each call is filed as a completed silent-screening record for audit and billed on success.
- Can be attached to a verification session by passing
sessionId. The result is then written to that session’sanalysis_data.phone_checksand shows up on Retrieve Session and in the console’s Carrier Intelligence tab. In this modephone(and, for ownership, the name) default to the session applicant. - Are also available as passive workflow steps that run automatically when a session is created, so the same results appear under
phone_checkswhether the check ran at creation or on demand. - Accept
application/jsonbodies using camelCase field names, like the other screening endpoints. - Are passive. They never block, fail, or change a session’s status on their own. Read the outcome and act on it in your own flow.
Outcomes and coverage
Every check reportsNO_DATA when the carrier holds no servable data for the number. This is the normal answer where the carrier route is not yet live, and it never counts against the applicant: Phone Trust does not trip, Carrier Age Gate does not fail, Phone Ownership does not mismatch.
Treat
NO_DATA as “no signal”, not as a failure, and design your flow so it degrades gracefully.
Billing
- Standalone calls are billed once per successful call, per check.
- Session-attached calls are billed once per successful call, per check, unless the session’s workflow already contains the matching passive step. In that case the check was billed at session creation and the on-demand call is free.
- A
503from the carrier provider is never billed. Retry later.
Errors
Example: gate a login on a phone number
tripped is true, route the user to a step-up before granting access. If every signal is NO_DATA, proceed as normal.