Retrieve an applicant's report for an entry

get

https://enterprise-api.demo.snappt.com/applicants/{applicantId}/report

Path Params

applicantId

uuid

required

Query Params

includeDocuments

boolean

Defaults to true

deprecated

Pass false to omit the contents of the applicant documents from the report and include only the result. Note: this parameter will be deprecated in the future. use preset instead.

showThumbnails

boolean

Defaults to true

deprecated

Pass false to omit thumbnail images and receive a FCRA compatible report. Note: this parameter will only have an effect if includeDocuments=false Note: this parameter will be deprecated in the future. use preset instead.

preset

string

enum

Defaults to summary-and-documents

Pass fcra to receive a FCRA compatible report, summary to receive a report without documents or summary-and-documents to receive a report with the applicant's documents included.

Allowed:

format

string

enum

Defaults to pdf

Pass HTML to get an HTML version of the report instead of the default PDF format.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A application/pdf payload

400The request payload or query string parameter you passed was not valid

401The Authorization header or Snappt applicant session token you passed was not valid

404The item you requested could not be found