Sandbox
Reports API v2

Fetch status and download reports

Retrieve applicant status, credit-check details, and download the final PDF report once checks are complete.

Download the report

Once a reference is complete (typically signalled by the applicant/completed webhook), download the PDF report.

cURL: download PDF report

JSON/HTTP
export LETS_SAFE_BASE_URL="https://portal.letssafe.com"
# Sandbox: https://sandbox.letssafe.com
export LETS_SAFE_API_KEY="YOUR_API_KEY"
export APPLICANT_ID="987fcdeb-51a2-43d1-b789-123456789abc"

curl -H "apikey: $LETS_SAFE_API_KEY" \
  -o "letssafe-report-$APPLICANT_ID.pdf" \
  "$LETS_SAFE_BASE_URL/api/v2/applicants/$APPLICANT_ID/pdf"

PDF generation busy

If the PDF endpoint returns 429 with a Retry-After header, wait and retry.

Check applicant status

Use GET /api/v2/applicants/:applicant_id to fetch the current state for an applicant (e.g. completion timestamps).

cURL: get applicant details

JSON/HTTP
export LETS_SAFE_BASE_URL="https://portal.letssafe.com"
# Sandbox: https://sandbox.letssafe.com
export LETS_SAFE_API_KEY="YOUR_API_KEY"
export APPLICANT_ID="987fcdeb-51a2-43d1-b789-123456789abc"

curl -H "apikey: $LETS_SAFE_API_KEY" \
  "$LETS_SAFE_BASE_URL/api/v2/applicants/$APPLICANT_ID"

Credit check details

For structured credit-check outputs, use GET /api/v2/applicants/:applicant_id/credit-check-details .

cURL: get credit check details

JSON/HTTP
export LETS_SAFE_BASE_URL="https://portal.letssafe.com"
# Sandbox: https://sandbox.letssafe.com
export LETS_SAFE_API_KEY="YOUR_API_KEY"
export APPLICANT_ID="987fcdeb-51a2-43d1-b789-123456789abc"

curl -H "apikey: $LETS_SAFE_API_KEY" \
  "$LETS_SAFE_BASE_URL/api/v2/applicants/$APPLICANT_ID/credit-check-details"

Common errors

  • 401 Missing/invalid API key
  • 400 Validation failed on create reference
  • 404 Unknown applicant or report not ready
  • 429 PDF generation busy (retry after)