Consents

Consents are documents that must be signed by the candidate before a report can be generated.
Use this resource to retrieve the necessary consents for a given account package and candidate location.

List All Consents

Retrieve the necessary consents for a given account package and candidate location

SecurityApiKey
Request
query Parameters
account_package_id
required
string <uuid>

Account package ID. Use id from List Account Packages

candidate_location[city]
string

City location of the candidate.

candidate_location[country]
string

Country code of the candidate location. If not provided, default value is US.

candidate_location[state]
required
string

State location of the candidate. Two-letter state abbreviation.

Responses
200

Consent details.

401

Unauthorized

404

Not Found

get/consents
Request samples
Response samples
application/json
[
  • {
    }
]