{ "openapi": "3.1.0", "info": { "title": "PrimaryCheck API", "version": "2026-11-03", "description": "Primary-source verification for licenses, NPI, exclusions, certifications, education and employment. JSON, camelCase, ISO-8601 UTC timestamps, ISO-3166-2 states. Async by default: create returns `201` with claims `pending`; long-poll with `?wait=25` or subscribe to signed webhooks. One error shape everywhere. Every response carries `Request-Id`, `PrimaryCheck-Version`, `X-RateLimit-Limit` and `X-RateLimit-Remaining`.", "contact": { "name": "PrimaryCheck support", "email": "support@primarycheck.com", "url": "https://primarycheck.com/docs" }, "termsOfService": "https://primarycheck.com/compliance" }, "servers": [ { "url": "https://api.primarycheck.com", "description": "Live (pc_live_… keys)" }, { "url": "https://sandbox.primarycheck.com", "description": "Sandbox (pc_test_… keys; deterministic sources, webhooks fire)" } ], "security": [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ], "tags": [ { "name": "Verifications", "description": "Create a verification with one to fifty claims, read it (long-poll with ?wait=), list, cancel, and fetch the consumer report." }, { "name": "Evidence", "description": "Every source result carries evidence ids. Fetch metadata, hashes and a 15-minute signed download URL." }, { "name": "Monitors", "description": "Re-check a claim on a cadence and receive monitor.changed webhooks." }, { "name": "Consents", "description": "Hosted FCRA disclosure and authorization: create a link, read its status." }, { "name": "Webhooks", "description": "Endpoints, signed deliveries, retries and replay." }, { "name": "Coverage and sources", "description": "What can be verified where, the profession taxonomy, and every connector's status. Unauthenticated." }, { "name": "Account", "description": "Account settings, usage and spend, team members and invites." }, { "name": "API keys", "description": "Create, list and revoke keys (dashboard session required)." }, { "name": "Sign-up and sessions", "description": "Self-serve sign-up and magic-link sessions used by the dashboard." }, { "name": "Disputes", "description": "Consumer-initiated disputes touching this account's reports." }, { "name": "Adverse action", "description": "Pre-adverse and final adverse-action notices with the waiting period enforced." }, { "name": "FCRA program", "description": "Customer vetting application, notices, and the account's FCRA status." }, { "name": "Health", "description": "Liveness." } ], "paths": { "/v1/verifications": { "post": { "summary": "Create a verification", "description": "Async by default: 201 with every claim `pending`; work runs on the queue; webhooks fire on completion.\n`?wait=` long-polls up to 25 s so fast checks (boards, datasets) return complete in one call.", "operationId": "verifications.create_a_verification", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 25, "minimum": 0, "default": 0, "title": "Wait" } }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Verification" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Verifications" ] }, "get": { "summary": "List verifications", "operationId": "verifications.list_verifications", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "description": "pending | complete | cancelled" }, { "name": "reference", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference" }, "description": "Your reference, exact match." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" }, "description": "1–100, default 25." }, { "name": "startingAfter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startingafter" }, "description": "Cursor: the last id of the previous page." }, { "name": "createdAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ISO-8601 timestamp." }, { "name": "personLastName", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Exact last name." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Verification" } }, "hasMore": { "type": "boolean" } }, "required": [ "data" ] } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Verifications" ], "description": "Cursor-paginated. Filters: `status`, `reference`, `createdAfter`, `personLastName`." } }, "/v1/verifications/{id}": { "get": { "summary": "Retrieve a verification", "description": "`?wait=` long-polls up to 25 s for a pending verification to complete.", "operationId": "verifications.retrieve_a_verification", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The verification id." }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 25, "minimum": 0, "default": 0, "title": "Wait" } }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Verification" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Verifications" ] } }, "/v1/verifications/{id}/cancel": { "post": { "summary": "Cancel a verification", "operationId": "verifications.cancel_a_verification", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The verification id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Verification" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Verifications" ], "description": "Pending claims become `unable_to_verify(cancelled)`; final claims keep their verdicts. Open outreach jobs are closed and a `verification.updated` webhook fires. `409 already_complete` when nothing is pending." } }, "/v1/verifications/{id}/evidence": { "get": { "summary": "List evidence for a verification", "operationId": "verifications.list_evidence_for_a_verification", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The verification id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EvidenceIndexRow" } } }, "required": [ "data" ] } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Verifications" ], "description": "The evidence index across every claim and source. Use `GET /v1/evidence/{id}` for a signed download URL." } }, "/v1/verifications/{id}/report.pdf": { "get": { "summary": "Download the consumer report PDF", "operationId": "verifications.download_the_consumer_report_pdf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The verification id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "The consumer report.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Verifications" ], "description": "Every claim with its field checks and an evidence index; the FCRA Summary of Rights is appended. Response is `application/pdf`." } }, "/v1/evidence/{id}": { "get": { "summary": "Retrieve evidence", "operationId": "evidence.retrieve_evidence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Evd Id" }, "description": "The object id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvidenceObject" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Evidence" ], "description": "Metadata, `sha256`, and a signed `url` that expires at `expiresAt` (about 15 minutes)." } }, "/v1/evidence/{id}/content": { "get": { "summary": "Download evidence content", "description": "The bytes behind an evidence record. Reachable through the signed `url` (`?exp=&sig=`, no API key) or with the owning account's key.", "operationId": "evidence.download_evidence_content", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Evd Id" }, "description": "The object id." }, { "name": "exp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exp" } }, { "name": "sig", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sig" } }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "The evidence bytes (JSON, PDF, PNG or HTML).", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Evidence" ], "security": [] } }, "/v1/monitors": { "post": { "summary": "Create a monitor", "operationId": "monitors.create_a_monitor", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorIn" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Monitor" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Monitors" ] }, "get": { "summary": "List monitors", "operationId": "monitors.list_monitors", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Monitor" } }, "hasMore": { "type": "boolean" } }, "required": [ "data" ] } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Monitors" ] } }, "/v1/monitors/{id}": { "get": { "summary": "Retrieve a monitor", "operationId": "monitors.retrieve_a_monitor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Mon Id" }, "description": "The monitor id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Monitor" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Monitors" ] }, "delete": { "summary": "Stop a monitor", "operationId": "monitors.stop_a_monitor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Mon Id" }, "description": "The monitor id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorStopped" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Monitors" ], "description": "Billing stops at the end of the current period." } }, "/v1/monitors/{id}/events": { "get": { "summary": "List monitor change events", "operationId": "monitors.list_monitor_change_events", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Mon Id" }, "description": "The monitor id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MonitorEvent" } }, "hasMore": { "type": "boolean" } }, "required": [ "data" ] } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Monitors" ] } }, "/v1/consents": { "post": { "summary": "Create a hosted consent", "operationId": "consents.create_a_hosted_consent", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentIn" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentRecord" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Consents" ], "description": "Returns a `url` to send the candidate to. The signed disclosure is stored as evidence." } }, "/v1/consents/{id}": { "get": { "summary": "Retrieve a consent", "operationId": "consents.retrieve_a_consent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Cons Id" }, "description": "The consent id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentRecord" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Consents" ] } }, "/v1/webhook_endpoints": { "post": { "summary": "Create a webhook endpoint", "operationId": "webhooks.create_a_webhook_endpoint", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointIn" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreated" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ], "description": "The signing `secret` is returned once." }, "get": { "summary": "List webhook endpoints", "operationId": "webhooks.list_webhook_endpoints", "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "hasMore": { "type": "boolean" } }, "required": [ "data" ] } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ] } }, "/v1/webhook_endpoints/{id}": { "delete": { "summary": "Delete a webhook endpoint", "operationId": "webhooks.delete_a_webhook_endpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ep Id" }, "description": "The webhook id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deleted" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ] } }, "/v1/webhook_endpoints/{id}/deliveries": { "get": { "summary": "List deliveries", "operationId": "webhooks.list_deliveries", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ep Id" }, "description": "The webhook id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDelivery" } }, "hasMore": { "type": "boolean" } }, "required": [ "data" ] } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ], "description": "Most recent first, with status code, latency and the next retry time." } }, "/v1/webhook_endpoints/{id}/deliveries/{deliveryId}/retry": { "post": { "summary": "Retry a delivery", "operationId": "webhooks.retry_a_delivery", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ep Id" }, "description": "The webhook id." }, { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string", "title": "Delivery Id" }, "description": "The webhook id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queued" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Webhooks" ] } }, "/v1/coverage": { "get": { "summary": "Coverage by state and profession", "operationId": "coverage_and_sources.coverage_by_state_and_profession", "parameters": [ { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "description": "ISO-3166-2 code, e.g. PA." }, { "name": "profession", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profession" }, "description": "Taxonomy key from GET /v1/professions." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageRow" } } }, "required": [ "data" ] } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Coverage and sources" ], "description": "Without filters, every (state, profession) row.", "security": [] } }, "/v1/professions": { "get": { "summary": "Profession taxonomy", "operationId": "coverage_and_sources.profession_taxonomy", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Profession" } } }, "required": [ "data" ] } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Coverage and sources" ], "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "security": [] } }, "/v1/sources": { "get": { "summary": "Sources", "description": "Every connector with mode, role, status, last canary and 24-hour error rate.", "operationId": "coverage_and_sources.sources", "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Source" } } }, "required": [ "data" ] } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Coverage and sources" ], "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "security": [] } }, "/v1/account": { "patch": { "summary": "Update the account", "operationId": "account.update_the_account", "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPatch" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUpdated" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Account" ], "description": "Owner or admin session." }, "get": { "summary": "Retrieve the account", "operationId": "account.retrieve_the_account", "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Account" ] } }, "/v1/account/audit": { "get": { "summary": "Export the audit log", "operationId": "account.export_the_audit_log", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Since" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 5000, "default": 1000, "title": "Limit" } }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Account" ], "description": "Every key, user and consumer action on this account, newest first." } }, "/v1/account/members": { "get": { "summary": "List team members", "operationId": "account.list_team_members", "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } }, "required": [ "data" ] } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Account" ] } }, "/v1/account/members/invites": { "post": { "summary": "Invite a team member", "operationId": "account.invite_a_team_member", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteIn" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invite" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Account" ], "description": "Owner or admin session. The invite is mailed; valid for 7 days." } }, "/v1/account/members/{id}": { "patch": { "summary": "Change a member's role", "operationId": "account.change_a_member_s_role", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Id" }, "description": "The object id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolePatch" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Account" ] }, "delete": { "summary": "Remove a member", "operationId": "account.remove_a_member", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Member Id" }, "description": "The object id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Account" ] } }, "/v1/usage": { "get": { "summary": "Usage and spend", "operationId": "account.usage_and_spend", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" }, "description": "YYYY-MM-DD or ISO-8601; default 30 days before `to`." }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" }, "description": "YYYY-MM-DD (inclusive) or ISO-8601; default now." }, { "name": "groupBy", "in": "query", "required": false, "schema": { "type": "string", "default": "day", "title": "Groupby" }, "description": "`day` (default) or `type`." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Usage" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Account" ], "description": "Counts and spend by claim type for a date range, split by channel (API vs dashboard). `groupBy=day` (default) or `type`." } }, "/v1/api_keys": { "get": { "summary": "List API keys", "operationId": "api_keys.list_api_keys", "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "A page of results.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } } }, "required": [ "data" ] } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "API keys" ] }, "post": { "summary": "Create an API key", "operationId": "api_keys.create_an_api_key", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyIn" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreated" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "API keys" ], "description": "Session required. The full `key` is returned once. Live keys need owner or admin." } }, "/v1/api_keys/{id}": { "delete": { "summary": "Revoke an API key", "operationId": "api_keys.revoke_an_api_key", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" }, "description": "The api key id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "API keys" ] } }, "/v1/invites/{token}/accept": { "post": { "summary": "Accept an invite", "operationId": "sign_up_and_sessions.accept_an_invite", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "title": "Token" }, "description": "The sign-up and session id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptIn" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Sign-up and sessions" ], "description": "Returns a session.", "security": [] } }, "/v1/sessions": { "post": { "summary": "Request a magic link", "description": "Always `202`; never reveals whether the email exists.", "operationId": "sign_up_and_sessions.request_a_magic_link", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionIn" } } }, "required": true }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkRequested" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Sign-up and sessions" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "security": [] } }, "/v1/sessions/current": { "delete": { "summary": "Sign out", "operationId": "sign_up_and_sessions.sign_out", "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Sign-up and sessions" ] } }, "/v1/sessions/exchange": { "post": { "summary": "Exchange a login token for a session", "operationId": "sign_up_and_sessions.exchange_a_login_token_for_a_session", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeIn" } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Session" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Sign-up and sessions" ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "security": [] } }, "/v1/signup": { "post": { "summary": "Sign up", "operationId": "sign_up_and_sessions.sign_up", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupIn" } } }, "required": true }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupResult" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Sign-up and sessions" ], "description": "Creates the account, the owner user and a default test key; mails a sign-in link.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "security": [] } }, "/v1/disputes": { "get": { "summary": "List disputes", "operationId": "disputes.list_disputes", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Disputes" ], "description": "Disputes consumers opened against this account's reports, with status and due dates." } }, "/v1/disputes/{id}": { "get": { "summary": "Retrieve a dispute", "operationId": "disputes.retrieve_a_dispute", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Dispute Id" }, "description": "The dispute id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Disputes" ], "description": "Status, `dueAt`, outcome and the corrected verification id when resolved." } }, "/v1/verifications/{id}/adverse_action": { "post": { "summary": "Start adverse action", "operationId": "adverse_action.start_adverse_action", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The object id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdverseIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Adverse action" ], "description": "Sends the pre-adverse notice with the report copy and Summary of Rights; starts the waiting period." }, "get": { "summary": "Retrieve adverse-action status", "operationId": "adverse_action.retrieve_adverse_action_status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The object id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Adverse action" ] } }, "/v1/verifications/{id}/adverse_action/final": { "post": { "summary": "Send the final adverse-action notice", "operationId": "adverse_action.send_the_final_adverse_action_notice", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The object id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdverseIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Adverse action" ], "description": "Refused until the waiting period has passed." } }, "/v1/verifications/{id}/adverse_action/notice.{fmt}": { "get": { "summary": "Download an adverse-action notice", "operationId": "adverse_action.download_an_adverse_action_notice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The object id." }, { "name": "fmt", "in": "path", "required": true, "schema": { "type": "string", "title": "Fmt" }, "description": "The object id." }, { "name": "stage", "in": "query", "required": false, "schema": { "type": "string", "default": "pre_adverse", "title": "Stage" } }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Adverse action" ], "description": "`fmt` is `pdf` or `html`." } }, "/v1/verifications/{id}/adverse_action/withdraw": { "post": { "summary": "Withdraw adverse action", "operationId": "adverse_action.withdraw_adverse_action", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Vid" }, "description": "The object id." }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Adverse action" ] } }, "/v1/account/fcra": { "get": { "summary": "FCRA status", "operationId": "fcra_program.fcra_status", "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "FCRA program" ], "description": "`fcraStatus`, certified purposes and the vetting application." } }, "/v1/account/fcra/application": { "post": { "summary": "Apply for FCRA access", "operationId": "fcra_program.apply_for_fcra_access", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FcraApplication" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "FCRA program" ], "description": "Customer vetting (§607(a)). Live keys are issued after approval." } }, "/v1/account/fcra/notices/accept": { "post": { "summary": "Accept the FCRA notices", "operationId": "fcra_program.accept_the_fcra_notices", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoticesAccept" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Validation failed (`validation_error`, `param` names the field) or a domain rule (`profession_unknown`, `cadence_invalid`, …).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, unknown or revoked key (`missing_api_key`, `invalid_api_key`, `invalid_session`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`fcra_not_enabled`, `purpose_not_certified`, `consent_required`, `read_only_role`, `session_required`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`idempotency_conflict`, `already_complete`, `already_cancelled`, `consent_already_signed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "FCRA program" ], "description": "Records acceptance of the Notice to Users and related notices." } }, "/v1/notices": { "get": { "summary": "List FCRA notice documents", "operationId": "fcra_program.list_fcra_notice_documents", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "FCRA program" ], "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "security": [] } }, "/v1/notices/{name}": { "get": { "summary": "Retrieve an FCRA notice document", "operationId": "fcra_program.retrieve_an_fcra_notice_document", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" }, "description": "The object id." }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "default": "json", "title": "Format" } }, { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "No such object on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "FCRA program" ], "security": [] } }, "/v1/health": { "get": { "summary": "Health", "operationId": "health.health", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } }, "429": { "description": "Rate limited (`rate_limited`). Wait `Retry-After` seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait." } } }, "default": { "description": "Any other error, in the one error shape.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "Health" ], "parameters": [ { "$ref": "#/components/parameters/PrimaryCheckVersion" } ], "security": [] } } }, "components": { "schemas": { "AcceptIn": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] } }, "type": "object", "title": "AcceptIn" }, "Account": { "type": "object", "properties": { "id": { "type": "string", "example": "acct_…" }, "name": { "type": "string", "nullable": true }, "fcraStatus": { "type": "string", "enum": [ "not_applied", "pending", "enabled" ] }, "certifiedPurposes": { "type": "array", "items": { "type": "string" } }, "version": { "type": "string", "example": "2026-11-03" }, "controlsVersion": { "type": "string" }, "plan": { "type": "string", "nullable": true }, "limits": { "type": "object" }, "auth": { "type": "string", "enum": [ "key", "session" ] }, "role": { "type": "string", "nullable": true }, "user": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string", "nullable": true } } } } }, "AccountPatch": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 200, "minLength": 1 }, { "type": "null" } ] } }, "type": "object", "title": "AccountPatch" }, "AccountUpdated": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "plan": { "type": "string", "nullable": true }, "fcraStatus": { "type": "string" } } }, "AccuracyOutcome": { "properties": { "outcome": { "type": "string", "pattern": "^(correct|wrong_verified|wrong_discrepancy|wrong_other)$" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "outcome" ], "title": "AccuracyOutcome" }, "AdverseIn": { "properties": { "reasonSummary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deliverToEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "title": "AdverseIn" }, "ApiKey": { "type": "object", "properties": { "id": { "type": "string", "example": "key_…" }, "name": { "type": "string" }, "mode": { "type": "string", "enum": [ "live", "test" ] }, "prefix": { "type": "string", "example": "pc_live_3kd9" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "ApiKeyCreated": { "allOf": [ { "$ref": "#/components/schemas/ApiKey" }, { "type": "object", "properties": { "key": { "type": "string", "description": "The full key. Shown once." } }, "required": [ "key" ] } ] }, "ApproveIn": { "properties": { "certifiedPurposes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "adverseActionWaitDays": { "anyOf": [ { "type": "integer", "maximum": 30.0, "minimum": 5.0 }, { "type": "null" } ] } }, "type": "object", "title": "ApproveIn" }, "CertificationClaim": { "properties": { "claimId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "const": "certification", "default": "certification" }, "issuer": { "type": "string" }, "credentialId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "issuer" ], "title": "CertificationClaim" }, "ChannelUsage": { "type": "object", "properties": { "count": { "type": "integer" }, "spendCents": { "type": "integer" } } }, "ChecklistIn": { "properties": { "item": { "type": "string" }, "done": { "type": "boolean", "default": true }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "item" ], "title": "ChecklistIn" }, "ClaimResult": { "properties": { "claimIndex": { "type": "integer" }, "claimId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string" }, "verdict": { "$ref": "#/components/schemas/Verdict" }, "reason": { "anyOf": [ { "$ref": "#/components/schemas/Reason" }, { "type": "null" } ] }, "input": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "results": { "items": { "$ref": "#/components/schemas/ConnectorResult" }, "type": "array" }, "parts": { "items": { "$ref": "#/components/schemas/ClaimResult" }, "type": "array" } }, "type": "object", "required": [ "claimIndex", "type", "verdict" ], "title": "ClaimResult" }, "ConnectorResult": { "properties": { "sourceCode": { "type": "string" }, "status": { "$ref": "#/components/schemas/SourceStatus" }, "verdict": { "$ref": "#/components/schemas/Verdict" }, "reason": { "anyOf": [ { "$ref": "#/components/schemas/Reason" }, { "type": "null" } ] }, "fieldChecks": { "items": { "$ref": "#/components/schemas/FieldCheck" }, "type": "array" }, "evidence": { "items": { "$ref": "#/components/schemas/Evidence" }, "type": "array" }, "record": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "checkedAt": { "type": "string", "format": "date-time" }, "dataAsOf": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reusedFrom": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "sourceCode", "status", "verdict" ], "title": "ConnectorResult" }, "Consent": { "properties": { "consentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "disclosureVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "signedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "signerIp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "title": "Consent", "description": "Proof the employer obtained FCRA §604(b)(2) disclosure + authorization." }, "ConsentIn": { "properties": { "person": { "$ref": "#/components/schemas/Person" }, "purpose": { "type": "string", "enum": [ "employment", "current_staff_monitoring", "network_credentialing" ], "default": "employment" }, "customerName": { "type": "string", "nullable": true, "description": "Shown on the hosted page as the party ordering the report." }, "state": { "type": "string", "nullable": true, "description": "Consumer's state for state-specific disclosure add-ons (CA, NY, …)." } }, "type": "object", "required": [ "person" ], "title": "ConsentIn" }, "ConsentRecord": { "type": "object", "properties": { "id": { "type": "string", "example": "cons_…" }, "object": { "type": "string", "enum": [ "consent" ] }, "status": { "type": "string", "enum": [ "pending", "signed", "expired" ] }, "purpose": { "type": "string" }, "person": { "$ref": "#/components/schemas/Person" }, "disclosureVersion": { "type": "string" }, "stateAddons": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "nullable": true, "description": "Hosted consent page; null once signed." }, "signedAt": { "type": "string", "format": "date-time", "nullable": true }, "signerIp": { "type": "string", "nullable": true }, "evidenceId": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } } }, "CoverageRow": { "type": "object", "properties": { "state": { "type": "string", "example": "PA" }, "profession": { "type": "string", "example": "rn" }, "label": { "type": "string" }, "board": { "type": "string" }, "boardType": { "type": "string" }, "source": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "live", "degraded", "building", "blocked" ] }, "searchBy": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "type": "string" } }, "compact": { "type": "string", "nullable": true }, "lookupUrl": { "type": "string", "nullable": true } } }, "Deleted": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [ true ] } } }, "DenyIn": { "properties": { "reason": { "type": "string", "minLength": 3 } }, "type": "object", "required": [ "reason" ], "title": "DenyIn" }, "DisputeIn": { "properties": { "verificationId": { "type": "string" }, "claimIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "statement": { "type": "string", "minLength": 10 }, "documents": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } }, "type": "object", "required": [ "verificationId", "statement" ], "title": "DisputeIn" }, "EducationClaim": { "properties": { "claimId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "const": "education", "default": "education" }, "school": { "type": "string" }, "schoolState": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "degree": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "major": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "graduatedYear": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "attendedFrom": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attendedTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "school" ], "title": "EducationClaim" }, "EmploymentClaim": { "properties": { "claimId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "const": "employment", "default": "employment" }, "employer": { "type": "string" }, "employerCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employerState": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suppliedContactPhone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suppliedContactEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "employer" ], "title": "EmploymentClaim" }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "authentication", "permission", "invalid_request", "fcra", "rate_limit_error", "conflict", "not_found", "api_error" ] }, "code": { "type": "string", "example": "profession_unknown" }, "message": { "type": "string" }, "param": { "type": "string", "nullable": true, "example": "claims[0].profession" }, "requestId": { "type": "string", "example": "req_7c1e0b1f2a9d4e8f" }, "docUrl": { "type": "string", "example": "https://primarycheck.com/docs/errors#profession_unknown" } }, "required": [ "type", "code", "message" ] } }, "required": [ "error" ] }, "Evidence": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "api_response", "page_capture", "dataset_row", "document", "rendered_record", "outreach_log", "call_transcript", "partner_response" ] }, "sourceCode": { "type": "string" }, "sourceUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ {}, { "type": "null" } ] }, "ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "kind", "sourceCode" ], "title": "Evidence" }, "EvidenceIndexRow": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "claimIndex": { "type": "integer" }, "source": { "type": "string" }, "kind": { "type": "string" }, "sha256": { "type": "string", "nullable": true }, "capturedAt": { "type": "string", "format": "date-time" }, "sourceUrl": { "type": "string", "nullable": true }, "ref": { "type": "string", "nullable": true }, "inline": { "type": "boolean" }, "index": { "type": "integer" } } }, "EvidenceObject": { "type": "object", "properties": { "id": { "type": "string", "example": "evd_…" }, "object": { "type": "string", "enum": [ "evidence" ] }, "verificationId": { "type": "string" }, "sourceCode": { "type": "string", "example": "PA-PALS" }, "kind": { "type": "string", "enum": [ "api_response", "page_capture", "dataset_row", "document", "rendered_record", "outreach_log", "call_transcript", "partner_response" ] }, "sourceUrl": { "type": "string", "nullable": true }, "contentType": { "type": "string", "example": "application/pdf" }, "sha256": { "type": "string" }, "bytes": { "type": "integer" }, "capturedAt": { "type": "string", "format": "date-time" }, "url": { "type": "string", "description": "Signed download URL; no API key needed." }, "expiresAt": { "type": "string", "format": "date-time" } } }, "ExchangeIn": { "properties": { "token": { "type": "string", "minLength": 8 } }, "type": "object", "required": [ "token" ], "title": "ExchangeIn" }, "ExclusionScreen": { "properties": { "claimId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "const": "exclusion_screen", "default": "exclusion_screen" }, "npi": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "title": "ExclusionScreen", "description": "Not a claim the person makes; a screen the customer asks for (healthcare bundle)." }, "FcraApplication": { "properties": { "legalName": { "type": "string", "minLength": 2 }, "ein": { "type": "string", "pattern": "^\\d{2}-?\\d{7}$" }, "address": { "type": "string", "minLength": 8 }, "website": { "type": "string", "pattern": "^https?://" }, "natureOfBusiness": { "type": "string", "minLength": 10 }, "intendedPurposes": { "items": { "type": "string" }, "type": "array", "minItems": 1 }, "expectedMonthlyVolume": { "type": "integer", "minimum": 1.0 }, "signerName": { "type": "string", "minLength": 2 }, "signerTitle": { "type": "string", "minLength": 2 }, "agreementAccepted": { "type": "boolean" }, "agreementVersion": { "type": "string" }, "certifications": { "additionalProperties": true, "type": "object" } }, "type": "object", "required": [ "legalName", "ein", "address", "website", "natureOfBusiness", "intendedPurposes", "expectedMonthlyVolume", "signerName", "signerTitle", "agreementAccepted", "agreementVersion" ], "title": "FcraApplication" }, "FieldCheck": { "properties": { "field": { "type": "string" }, "claimed": {}, "found": {}, "match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "field" ], "title": "FieldCheck" }, "FileRequest": { "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dob": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "email": { "type": "string", "pattern": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$" }, "last4": { "anyOf": [ { "type": "string", "maxLength": 4, "minLength": 4 }, { "type": "null" } ] }, "verificationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "firstName", "lastName", "dob", "email" ], "title": "FileRequest" }, "Health": { "type": "object", "properties": { "ok": { "type": "boolean" }, "controls": { "type": "string" }, "version": { "type": "string" } } }, "HealthcareScreenClaim": { "properties": { "claimId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "const": "healthcare_screen", "default": "healthcare_screen" }, "state": { "type": "string", "maxLength": 2, "minLength": 2 }, "profession": { "type": "string" }, "licenseNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "npi": { "anyOf": [ { "type": "string", "pattern": "^\\d{10}$" }, { "type": "null" } ] } }, "type": "object", "required": [ "state", "profession" ], "title": "HealthcareScreenClaim", "description": "Bundle: expands server-side into license + npi + exclusion_screen (docs/CHECK-TYPES.md §E)." }, "InboundEmail": { "properties": { "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "type": "string", "default": "" } }, "type": "object", "title": "InboundEmail" }, "InboundFax": { "properties": { "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fromNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "documentUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "type": "object", "title": "InboundFax" }, "InboundPayroll": { "properties": { "event_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tracking_info": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "payload": { "additionalProperties": true, "type": "object" } }, "type": "object", "title": "InboundPayroll" }, "InboundVoice": { "properties": { "jobId": { "type": "string" }, "transcript": { "type": "string", "default": "" }, "outcome": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recordingUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "jobId" ], "title": "InboundVoice" }, "Invite": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "acceptUrl": { "type": "string", "description": "Non-production only." } } }, "InviteIn": { "properties": { "email": { "type": "string" }, "role": { "type": "string", "default": "member" } }, "type": "object", "required": [ "email" ], "title": "InviteIn" }, "KeyIn": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1 }, "mode": { "type": "string", "pattern": "^(live|test)$" } }, "type": "object", "required": [ "name", "mode" ], "title": "KeyIn" }, "LicenseClaim": { "properties": { "claimId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "const": "license", "default": "license" }, "state": { "type": "string", "maxLength": 2, "minLength": 2 }, "profession": { "type": "string" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deaNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "state", "profession" ], "title": "LicenseClaim" }, "MagicLinkRequested": { "type": "object", "properties": { "sent": { "type": "boolean", "enum": [ true ] } } }, "Member": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string", "nullable": true }, "role": { "type": "string", "enum": [ "owner", "admin", "member", "viewer", "ops" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "Monitor": { "type": "object", "properties": { "id": { "type": "string", "example": "mon_…" }, "object": { "type": "string", "enum": [ "monitor" ] }, "status": { "type": "string", "enum": [ "active", "stopped" ] }, "cadence": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "person": { "$ref": "#/components/schemas/Person" }, "claim": { "type": "object", "description": "The claim exactly as sent." }, "snapshot": { "type": "object", "nullable": true, "description": "verdict, reason, watched record fields, actions count, checkedAt" }, "lastCheckedAt": { "type": "string", "format": "date-time", "nullable": true }, "nextCheckAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "stoppedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "MonitorEvent": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "verdict", "status", "expires", "action", "record" ] }, "diff": { "type": "object", "additionalProperties": { "type": "object", "properties": { "from": {}, "to": {} } } }, "webhookEventId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } } }, "MonitorIn": { "properties": { "person": { "$ref": "#/components/schemas/Person" }, "claim": { "oneOf": [ { "$ref": "#/components/schemas/LicenseClaim" }, { "$ref": "#/components/schemas/NpiClaim" }, { "$ref": "#/components/schemas/ExclusionScreen" }, { "$ref": "#/components/schemas/HealthcareScreenClaim" }, { "$ref": "#/components/schemas/CertificationClaim" }, { "$ref": "#/components/schemas/EducationClaim" }, { "$ref": "#/components/schemas/EmploymentClaim" } ], "discriminator": { "propertyName": "type", "mapping": { "certification": "#/components/schemas/CertificationClaim", "education": "#/components/schemas/EducationClaim", "employment": "#/components/schemas/EmploymentClaim", "exclusion_screen": "#/components/schemas/ExclusionScreen", "healthcare_screen": "#/components/schemas/HealthcareScreenClaim", "license": "#/components/schemas/LicenseClaim", "npi": "#/components/schemas/NpiClaim" } } }, "cadence": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "default": "weekly" }, "consent": { "anyOf": [ { "$ref": "#/components/schemas/Consent" }, { "type": "null" } ], "description": "Required on live accounts (consentId, or disclosureVersion + signedAt)." } }, "type": "object", "required": [ "person", "claim" ], "title": "MonitorIn" }, "MonitorStopped": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "stopped" ] } } }, "MoreInfo": { "properties": { "statement": { "type": "string", "minLength": 3 }, "documents": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } }, "type": "object", "required": [ "statement" ], "title": "MoreInfo" }, "NoticesAccept": { "properties": { "acceptedBy": { "type": "string", "minLength": 2 } }, "type": "object", "required": [ "acceptedBy" ], "title": "NoticesAccept" }, "NpiClaim": { "properties": { "claimId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "const": "npi", "default": "npi" }, "number": { "type": "string", "pattern": "^\\d{10}$" } }, "type": "object", "required": [ "number" ], "title": "NpiClaim" }, "Person": { "properties": { "firstName": { "type": "string" }, "middleName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "type": "string" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dob": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ] }, "aliases": { "items": { "type": "string" }, "type": "array" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "firstName", "lastName" ], "title": "Person" }, "Profession": { "type": "object", "properties": { "key": { "type": "string", "example": "rn" }, "label": { "type": "string" }, "category": { "type": "string" }, "boardType": { "type": "string" }, "compact": { "type": "string", "nullable": true } } }, "Purpose": { "type": "string", "enum": [ "employment", "current_staff_monitoring", "network_credentialing" ], "title": "Purpose" }, "Queued": { "type": "object", "properties": { "id": { "type": "string" }, "queued": { "type": "boolean", "enum": [ true ] } } }, "Reason": { "type": "string", "enum": [ "no_coverage", "source_error", "source_timeout", "employer_policy", "employer_uses_third_party", "employer_closed", "employer_not_found", "no_response", "insufficient_identifiers", "ambiguous_match", "source_not_built", "source_stale", "source_degraded", "cancelled" ], "title": "Reason" }, "ReplyIn": { "properties": { "responderName": { "type": "string", "minLength": 2 }, "responderRole": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "confirmed": { "type": "boolean" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "degree": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "graduatedYear": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "refused": { "type": "boolean", "default": false }, "thirdParty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "responderName", "confirmed" ], "title": "ReplyIn" }, "Resolve": { "properties": { "outcome": { "type": "string" }, "answer": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "thirdParty": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "operator": { "type": "string" } }, "type": "object", "required": [ "outcome", "operator" ], "title": "Resolve" }, "ResolveIn": { "properties": { "outcome": { "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "outcome" ], "title": "ResolveIn" }, "RolePatch": { "properties": { "role": { "type": "string" } }, "type": "object", "required": [ "role" ], "title": "RolePatch" }, "Session": { "type": "object", "properties": { "sessionToken": { "type": "string", "example": "pcs_…" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string", "nullable": true } } }, "account": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "plan": { "type": "string", "nullable": true }, "fcraStatus": { "type": "string" }, "isStaff": { "type": "boolean" } } }, "role": { "type": "string", "enum": [ "owner", "admin", "member", "viewer", "ops" ] }, "expiresAt": { "type": "string", "format": "date-time" } } }, "SessionIn": { "properties": { "email": { "type": "string" } }, "type": "object", "required": [ "email" ], "title": "SessionIn" }, "SignIn": { "properties": { "typedName": { "type": "string", "minLength": 2 }, "agreed": { "type": "boolean" }, "consumerCopyRequested": { "type": "boolean", "default": false } }, "type": "object", "required": [ "typedName", "agreed" ], "title": "SignIn" }, "SignupIn": { "properties": { "email": { "type": "string" }, "name": { "type": "string", "maxLength": 200, "minLength": 1 }, "company": { "type": "string", "maxLength": 200, "minLength": 1 } }, "type": "object", "required": [ "email", "name", "company" ], "title": "SignupIn" }, "SignupResult": { "type": "object", "properties": { "account": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string", "nullable": true } } }, "loginUrl": { "type": "string", "description": "Non-production only." } } }, "Source": { "type": "object", "properties": { "code": { "type": "string", "example": "PA-PALS" }, "name": { "type": "string" }, "claimTypes": { "type": "array", "items": { "type": "string" } }, "mode": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "rung": { "type": "string", "nullable": true }, "lastCanaryAt": { "type": "string", "format": "date-time", "nullable": true }, "lastCanaryOk": { "type": "boolean", "nullable": true }, "errorRate24h": { "type": "number", "nullable": true }, "calls24h": { "type": "integer" }, "dataAsOf": { "type": "string", "format": "date-time", "nullable": true }, "datasetFresh": { "type": "boolean", "nullable": true }, "datasets": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "dataAsOf": { "type": "string", "format": "date-time", "nullable": true }, "rows": { "type": "integer" }, "maxAgeDays": { "type": "integer" } } } } } }, "SourcePatch": { "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "concurrency": { "anyOf": [ { "type": "integer", "maximum": 50.0, "minimum": 1.0 }, { "type": "null" } ] }, "ratePerS": { "anyOf": [ { "type": "number", "maximum": 100.0, "exclusiveMinimum": 0.0 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "type": "object", "title": "SourcePatch" }, "SourceStatus": { "type": "string", "enum": [ "ok", "error", "timeout", "no_coverage", "pending", "not_built" ], "title": "SourceStatus" }, "Usage": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "groupBy": { "type": "string", "enum": [ "day", "type" ] }, "counts": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Claims by type (license, healthcare_screen, …, monitor)." }, "spendCents": { "type": "integer" }, "byChannel": { "type": "object", "properties": { "api": { "$ref": "#/components/schemas/ChannelUsage" }, "dashboard": { "$ref": "#/components/schemas/ChannelUsage" } } }, "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY-MM-DD when groupBy=day" }, "type": { "type": "string", "description": "claim type when groupBy=type" }, "count": { "type": "integer" }, "spendCents": { "type": "integer" } } } } } }, "Verdict": { "type": "string", "enum": [ "verified", "discrepancy", "not_found", "unable_to_verify", "pending" ], "title": "Verdict" }, "Verification": { "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "complete", "cancelled" ] }, "purpose": { "$ref": "#/components/schemas/Purpose" }, "person": { "$ref": "#/components/schemas/Person" }, "claims": { "items": { "$ref": "#/components/schemas/ClaimResult" }, "type": "array" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "allowPaidThirdParty": { "type": "boolean", "default": false }, "maxAge": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "status", "purpose", "person", "claims" ], "title": "Verification" }, "VerificationOptions": { "properties": { "maxAge": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 duration; reuse a result we produced within this window. Default PT0S." }, "allowPaidThirdParty": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Route to The Work Number when an employer redirects there." }, "deadline": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 duration for employer/registrar outreach (default P7D)." } }, "type": "object", "title": "VerificationOptions", "description": "`options` on create (docs/API-V1.md). `maxAge`: ISO-8601 duration; accept a result we produced for the same\nclaim + person within this window (docs/MASTER-PLAN.md §4 result reuse). Default PT0S = always live." }, "VerificationRequest": { "properties": { "person": { "$ref": "#/components/schemas/Person" }, "claims": { "items": { "oneOf": [ { "$ref": "#/components/schemas/LicenseClaim" }, { "$ref": "#/components/schemas/NpiClaim" }, { "$ref": "#/components/schemas/ExclusionScreen" }, { "$ref": "#/components/schemas/HealthcareScreenClaim" }, { "$ref": "#/components/schemas/CertificationClaim" }, { "$ref": "#/components/schemas/EducationClaim" }, { "$ref": "#/components/schemas/EmploymentClaim" } ], "discriminator": { "propertyName": "type", "mapping": { "certification": "#/components/schemas/CertificationClaim", "education": "#/components/schemas/EducationClaim", "employment": "#/components/schemas/EmploymentClaim", "exclusion_screen": "#/components/schemas/ExclusionScreen", "healthcare_screen": "#/components/schemas/HealthcareScreenClaim", "license": "#/components/schemas/LicenseClaim", "npi": "#/components/schemas/NpiClaim" } } }, "type": "array", "maxItems": 50, "minItems": 1 }, "purpose": { "$ref": "#/components/schemas/Purpose" }, "consent": { "anyOf": [ { "$ref": "#/components/schemas/Consent" }, { "type": "null" } ] }, "options": { "anyOf": [ { "$ref": "#/components/schemas/VerificationOptions" }, { "type": "null" } ], "description": "maxAge (ISO-8601 duration, default PT0S = always live), allowPaidThirdParty, deadline." }, "allowPaidThirdParty": { "type": "boolean", "default": false, "deprecated": true, "description": "Deprecated top-level alias of `options.allowPaidThirdParty`; `options` wins when both are sent." }, "maxAge": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated top-level alias of `options.maxAge`; `options` wins when both are sent." }, "reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object", "required": [ "person", "claims", "purpose" ], "title": "VerificationRequest" }, "WebhookDelivery": { "type": "object", "properties": { "id": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "attempt": { "type": "integer" }, "statusCode": { "type": "integer", "nullable": true }, "responseMs": { "type": "integer", "nullable": true }, "deliveredAt": { "type": "string", "format": "date-time", "nullable": true }, "nextRetryAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } } }, "WebhookEndpoint": { "type": "object", "properties": { "id": { "type": "string", "example": "we_…" }, "object": { "type": "string", "enum": [ "webhook_endpoint" ] }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "mode": { "type": "string", "enum": [ "live", "test" ] }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "events" ] }, "WebhookEndpointCreated": { "allOf": [ { "$ref": "#/components/schemas/WebhookEndpoint" }, { "type": "object", "properties": { "secret": { "type": "string", "description": "Shown once. HMAC key for PrimaryCheck-Signature.", "example": "whsec_…" } }, "required": [ "secret" ] } ] }, "WebhookEndpointIn": { "properties": { "url": { "type": "string", "pattern": "^https?://", "example": "https://ats.example.com/primarycheck" }, "events": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "verification.completed", "verification.updated", "monitor.changed", "dispute.resolved", "consent.signed" ] } } }, "type": "object", "required": [ "url", "events" ], "title": "WebhookEndpointIn" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "pc_live_… | pc_test_… | pcs_… (dashboard session)", "description": "`Authorization: Bearer pc_live_…`. Live keys after FCRA vetting; `pc_test_…` keys on the sandbox host." }, "apiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "Alternative to the bearer header." } }, "parameters": { "PrimaryCheckVersion": { "name": "PrimaryCheck-Version", "in": "header", "required": false, "schema": { "type": "string", "example": "2026-11-03" }, "description": "Pin behavior to an API version date. Defaults to the version pinned on the account. Additive changes never bump it." }, "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "UUID. For 24 hours the same key returns the original response without re-running sources or billing. Same key with a different body → `409 idempotency_conflict`. The SDKs send one on every POST." } }, "headers": { "Request-Id": { "schema": { "type": "string" }, "description": "On every response; quote it to support." }, "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "Requests per minute allowed for the account." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "Remaining in the current window." } } } }