Skip to main content
GET
Get FCRA

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

language
enum<string>
required

The desired language for the legal document. Must be an ISO 639-1 code. Currently, the only supported value is en (English). If an unsupported language is requested, the call still succeeds but returns an English version of the document.

Available options:
en
caseId
string
required

The ID of a case.

Response

OK

alreadyAck
boolean
required

True if the candidate already acknowledged the FCRA document; false otherwise.

title
string
required

Escaped HTML.

body
string
required

Escaped HTML.

authorizationStatement
string
required

Escaped HTML.

authorizationObject
object
required
header
string

Escaped HTML.

caseDataId
string<uuid>

Returned only if alreadyAck is true.