Integration basics API v2

Integrate Lets Safe into your platform

Create credit checks, receive webhook events, and download reports automatically for your users.

Quickstart flow

A typical integration submits a credit check from your platform, waits for webhook notifications, then downloads the final report for your users.

Step 01

Get API key

Generate an API key and (optionally) set a webhook URL in the portal Settings.

Step 02

Create reference

Call POST /api/v2/references and store the ApplicantIds returned.

Step 03

Wait for events

Listen for applicant/completed to know when the report is ready.

Step 04

Download report

Call GET /api/v2/applicants/{id}/pdf and attach it to your workflow.

Authentication

Authenticate every request by sending your API key in the apikey header. The header name is case-insensitive, but we recommend using apikey exactly.

Base URL

All endpoints are served from a fixed Lets Safe API domain. Use


  https://portal.letssafe.com

and append


  /api/v2

. The sandbox environment is


  https://sandbox.letssafe.com

. You can also validate your integration against


  https://sandbox.letssafe.com

cURL: check credits

JSON/HTTP

export LETS_SAFE_BASE_URL="https://portal.letssafe.com"
# Sandbox: https://sandbox.letssafe.com
export LETS_SAFE_API_KEY="YOUR_API_KEY"

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

Request/response formats

Requests accept PascalCase fields.
Responses preserve PascalCase keys for compatibility.
Use Content-Type: application/json for JSON bodies.

Status & retries

If you cannot receive webhooks, you can poll for completion and then download the report.

At-least-once delivery

Webhooks may be delivered more than once. Treat them as idempotent and deduplicate by


  EventType

and


  Payload

cURL: list completed applicants

JSON/HTTP

export LETS_SAFE_BASE_URL="https://portal.letssafe.com"
# Sandbox: https://sandbox.letssafe.com
export LETS_SAFE_API_KEY="YOUR_API_KEY"

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

Next steps

Follow the guides in the left navigation for end-to-end examples of creating credit checks, handling webhooks, and downloading reports.