Skip to main content
PropertyValue
Dataset codeD01
Section codeS1 — Customers & Accounts
Endpoint path/exports/S1/D01
Cursor fieldupdated_at
Page size1–1000 (default 500)
AvailabilityAvailable (v1.2)
PaginationDirect (constant page size)
Each row is one borrower (customer) record we hold for this lender. It includes contact details, masked national/passport identifiers, language preference, the do-not-contact flag, and nested addresses/phones/emails.

​
Fields

FieldTypeDescriptionNotes
public_idstringStable per-row identifier (string-cast Mongo _id).Use as the warehouse primary key
first_namestringBorrower first name.
last_namestringBorrower last name.
countrystringCountry code or name.
preferred_languagestringPreferred communication language (en, ar, …).Source: pref_lang
do_not_contactbooleantrue when contact must be suppressed.
disputebooleantrue when the borrower has flagged a dispute.
id_numberstringNational ID.Masked — last 4 visible, rest masked with *
passport_numberstringPassport number.Masked — last 4 visible, rest masked with *
dobstringDate of birth.Masked — year only (4 digits)
addressesarray of objectAddress objects.Inner keys: country, city, area, type
phonesarray of objectPhone objects.Source array: phone. Inner: key_masked (phone-middle masked) + dnc
emailarray of objectEmail objects.Inner keys: key, dnc
created_atstringRecord creation timestamp (ISO-8601).
updated_atstringLast-modified timestamp (ISO-8601).Cursor field

​
addresses[] object

FieldTypeDescription
countrystringCountry code or name.
citystringCity.
areastringArea or district.
typestringAddress type (e.g. home, work).

​
phones[] object

FieldTypeDescription
key_maskedstringPhone number, phone-middle masked (first 3 + last 4 visible).
dncbooleantrue if this number is on the do-not-call list.

​
email[] object

FieldTypeDescription
keystringEmail address.
dncbooleantrue if this address is suppressed.

​
Sample row

{
  "public_id": "6981c72d7b92d56a743324cf",
  "first_name": "Ahmed",
  "last_name": "Al-Otaibi",
  "country": "SA",
  "preferred_language": "ar",
  "do_not_contact": false,
  "dispute": false,
  "id_number": "***********5371",
  "passport_number": "****2206",
  "dob": "1990",
  "addresses": [
    { "country": "SA", "city": "Riyadh", "area": "Olaya", "type": "home" }
  ],
  "phones": [
    { "key_masked": "966*****7228", "dnc": false }
  ],
  "email": [
    { "key": "ahmed.al-otaibi@example.com", "dnc": false }
  ],
  "created_at": "2026-01-12T08:42:01.000Z",
  "updated_at": "2026-05-30T14:11:22.000Z"
}
id_number, passport_number, dob, and each phone’s key_masked are always returned masked. The raw values are never exposed by this endpoint.

​
Pagination characteristics

This dataset is direct — filtered to your tenant by lender_id on the collection itself, so each page returns a constant number of rows until the last page.

​
Use cases

  • Customer master sync into your warehouse.
  • PII-masked enrichment table for analytics.
  • Do-not-contact (DNC) suppression upstream of outreach.

Need Help?

Our support team is available Monday-Friday, 9 AM - 6 PM GST. Reach out at support@cleargrid.co or visit our help center.