Skip to main content
GET
/
identity
/
entities
/
{customerId}
Get Customer Identity
curl --request GET \
  --url https://api.sandbox.sardine.ai/v1/identity/entities/{customerId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "documentKyc": {
    "front": "<string>",
    "back": "<string>",
    "selfie": "<string>"
  },
  "documentData": {
    "documentType": "DRIVERS_LICENSE",
    "documentNumber": "D1234567",
    "dateOfBirth": "1990-06-15",
    "expiryDate": "2028-06-15",
    "issuingCountry": "US",
    "firstName": "Jane",
    "lastName": "Smith",
    "gender": "F",
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "region": "CA",
      "postalCode": "94105"
    }
  },
  "profile": {
    "clientId": "acme-corp",
    "userId": "3f8c1a22-1234-4abc-9def-000000000001",
    "consentId": "b1c2d3e4-5678-4abc-9def-000000000002",
    "consentedAt": "2026-05-01T10:30:00Z",
    "revokedAt": null,
    "primaryIdentity": false,
    "clientName": "Acme Corp",
    "fullName": "Jane Smith",
    "dateOfBirth": "1990-06-15",
    "emailAddress": "jane@example.com",
    "phoneNumber": "+14155551234",
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "region": "CA",
      "postalCode": "94105"
    }
  },
  "level": "low",
  "customer": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.payments.sardine.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

HTTP Basic Auth. Use your clientId as the username and clientSecret as the password.

Path Parameters

​
customerId
string
required

Sardine customer UUID returned from POST /identity/entities

Response

Identity data for the customer

​
documentKyc
object

Document images, present only when doc_kyc scope was consented

​
documentData
object

Extracted document fields, present only when doc_kyc scope was consented

​
profile
object

Profile data, present only when profile scope was consented

​
level
enum<string>

Risk level of the user (high, medium, low). Present when risk enrichment is enabled for the client.

Available options:
high,
medium,
low
Example:

"low"

​
customer
object

Full risk customer object from the Sardine risk engine. Present when risk enrichment is enabled.