fcra

This account's FCRA Partner Access status

Changed on

Whether this account can place FCRA orders, the permissible purposes its agreement covers, and whether a webhook endpoint is configured. Never 403: an account without access gets enabled: false.

get/v1/fcra/partner

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/fcra/partner
  • Auth: API key in header X-API-Key

Response

The account's FCRA status.

enabledboolean
sandboxboolean
allowedPurposesstring[]
agreementRefstring nullable
enabledAtstring date-time nullable
webhookConfiguredboolean
trialboolean
role'admin' | 'user'

Changes