Get All Customers
GET
List customers with KYC levels for the authenticated tenant. Pass page_size to page through results; without it every customer is returned.
header
X-Api-Key<token>API key in format: sti_env_prefix_secret
page_size?integerRange
1 <= value <= 100page_token?stringDefault Response
application/json- response
customers*array<>List of customers with entitlements for the tenant
page?Present only when page_size was supplied
curl -X GET 'https://api.sandbox.stables.money/api/v1/customers'Example Response200
{ "customers": [ { "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "external_customer_id": "string", "customer_type": "individual", "email": "string", "phone": "string", "entitlements": [ { "name": "string", "status": "pending", "phase": "requires_action", "requirements": { "submitted": [ "string" ], "missing": [ "string" ], "issues": [ "string" ], "actions": [ { "type": "verification_link", "requirement": "string", "verification_type": "proof_of_address", "url": "http://example.com", "expires_at": "2019-08-24T14:15:22Z" } ], "review": { "status": "pending", "reason": "string", "decided_at": "2019-08-24T14:15:22Z", "version": -9007199254740991 }, "parties": [ { "ref": "string", "display_name": "string", "category": "string", "is_individual": true, "has_identity": true, "has_tax_id": true, "has_proof_of_address": true } ], "submission": { "state": "none", "version": -9007199254740991, "updated_at": "2019-08-24T14:15:22Z", "submitted_at": "2019-08-24T14:15:22Z" } }, "onboarding": { "stage": "verification_required", "next_action": "complete_verification", "reasons": [ { "code": "string", "resolution": "requirements" } ], "since": "2019-08-24T14:15:22Z", "expected_wait": "minutes" } } ], "first_name": "string", "last_name": "string", "company_name": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "metadata": { "property1": "string", "property2": "string" }, "verification_levels": [ { "level": "kyc_level_0", "status": "in_progress", "sub_status": [ "BAD_PROOF_OF_IDENTITY" ], "stage": "collecting", "submitted_at": "2019-08-24T14:15:22Z", "missing_fields": [ "string" ], "missing_field_details": [ { "field": "string", "request_path": "string", "description": "string" } ], "in_review": true, "details": [ { "reasons": [ { "code": "string", "description": "string" } ], "requirements": [ "string" ] } ], "review": { "labels": [ { "label": "string", "description": "string", "step": "string", "reason_code": "string", "requirements": [ "string" ] } ], "moderation_comment": "string", "reviewed_at": "2019-08-24T14:15:22Z" } } ], "doc_images": { "documents": [ { "type": "string", "country": "string", "document_number": "string", "expiry_date": "string", "front_image_data": "string", "back_image_data": "string", "image_data": "string", "outcome": "string" } ], "selfie_image_data": "string" }, "age_risk_questionnaire": { "reason_for_use": "string", "age_acknowledged": true }, "account_purpose": "PERSONAL_OR_LIVING_EXPENSES", "account_purpose_other": "string", "expected_monthly_volume": "0_9999", "occupation": "string", "occupation_title": "string", "annual_income": "0_24999", "status": "string", "compliance_lock": { "locked_at": "2019-08-24T14:15:22Z", "locked_by_user_id": "string", "locked_by_user_name": "string", "locked_by_user_email": "string", "lock_reason": "string" }, "property1": null, "property2": null } ], "page": { "next_page_token": "string", "total": -9007199254740991 }}