Create credit checks API v2

Create references and applicants

Submit credit checks from your system, manage applicants, and fetch hosted links for the applicant flow.

Create a credit check (reference)

A reference groups one or more applicants (up to 6). You create it with POST /api/v2/references. The response returns a reference ID plus a list of applicant IDs.

Idempotency with ReferenceId

Send a unique


  ReferenceId

(GUID) from your system to make retries safe. If you retry with the same


  ReferenceId

, Lets Safe returns the existing reference and applicants without double-charging credits.

Request: create reference

JSON/HTTP

POST /api/v2/references
Content-Type: application/json
apikey: YOUR_API_KEY

{
  "ReferenceId": "123e4567-e89b-12d3-a456-426614174000",
  "TenancyAddressLine1": "123 Example Street",
  "TenancyAddressTown": "London",
  "TenancyAddressCounty": "Greater London",
  "TenancyAddressPostcode": "SW1A 1AA",
  "TenancyMonthlyRent": 1500,
  "TenancyStartDate": "2025-09-01T00:00:00Z",
  "TenancyTerm": 12,
  "Applicants": [
    {
      "ApplicantFirstName": "Alex",
      "ApplicantLastName": "Taylor",
      "ApplicantEmailAddress": "alex.taylor@example.com",
      "ApplicantPhoneNumber": "07700900000",
      "Product": 4,
      "TenantShareOfRent": 1500
    }
  ]
}

Response: create reference

JSON/HTTP

{
  "Result": true,
  "Id": "123e4567-e89b-12d3-a456-426614174000",
  "ApplicantIds": [
    "987fcdeb-51a2-43d1-b789-123456789abc"
  ],
  "Error": null,
  "ValidationMessages": []
}

Product IDs

Set Product per applicant to control the checks performed.

Product	Meaning	Typical use
1	Full reference	Credit + affordability + references
4	Credit check	Credit-only workflow
3	Guarantor	Add a guarantor reference
5	Guarantor credit check	Credit-only guarantor

Get the applicant link

Use GET /api/v2/applicants/:applicant_id/link to fetch the hosted referencing link (for SMS, in-app messages, or embeds).

cURL: get applicant link

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/link"

Resend (or update) the invite email

If an applicant needs the email re-sent (or you need to change the email address first), call POST /api/v2/applicants/:applicant_id/email.

cURL: resend invite email

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 -X POST \
  -H "apikey: $LETS_SAFE_API_KEY" \
  -H "content-type: application/json" \
  -d '{ "EmailAddress": "alex.taylor@example.com" }' \
  "$LETS_SAFE_BASE_URL/api/v2/applicants/$APPLICANT_ID/email"