fcra

Register an end user

Changed on

Registers the employer, landlord or other business a report is for, with the permissible purposes it holds and your certification. Every purpose must be within your partner agreement (403 fcra_purpose_not_allowed).

post/v1/fcra/end-users

Request

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

Request body

namestring required
externalIdstring nullable
permissiblePurposesstring[] required

Response

The end user, status active.

idstring
namestring
externalIdstring nullable
permissiblePurposesstring[]
status'active' | 'suspended'
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "eu_0b44acbeefeaa7d7"
}

Changes