Object

The user object

Fields

idstringrequired: Starts with usr_.
objectstringrequired
typestringrequired: One of individual, business.
external_referencestringrequired
emailstring | null
phonestring | null
first_namestring | null
last_namestring | null
business_namestring | null
countrystring | null
statusstringrequired: One of active, deactivated.
kyc_statusstringrequired: One of not_started, under_review, incomplete, approved, rejected.
terms_statusstringrequired: One of pending, approved.
rejection_reasonsarray of objectrequired: Populated when kyc_status is rejected or incomplete.
metadataobject: Integrator key-value data, returned unchanged. Up to 50 keys; keys up to 40 characters, values up to 500.
versionintegerrequired
created_attimestamprequired
updated_attimestamprequired

Example

{
  "id": "usr_01JA8Z2F5G6H7J8K9M0N1P2Q3R",
  "object": "user",
  "type": "individual",
  "external_reference": "crm-1042",
  "email": "ama.moyo@example.com",
  "phone": "+263771234567",
  "first_name": "Ama",
  "last_name": "Moyo",
  "business_name": null,
  "country": "ZW",
  "status": "active",
  "kyc_status": "approved",
  "terms_status": "approved",
  "rejection_reasons": [],
  "metadata": {
    "segment": "retail"
  },
  "version": 3,
  "created_at": "2026-10-16T09:30:00Z",
  "updated_at": "2026-10-16T10:12:44Z"
}