fcra

Change an end user's purposes or suspend it

Changed on

A suspended end user cannot be named on a new order (422 end_user_suspended). Send status: "active" to reinstate it.

patch/v1/fcra/end-users/{end_user_id}

Request

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

Request body

permissiblePurposesstring[] nullable
status'active' | 'suspended' nullable

Response

The updated end user.

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

Example response

{
  "id": "eu_0b44acbeefeaa7d7"
}

Changes