Artha API
  1. Customers
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Update Customer
      PATCH
  • Cards
    • Submit KYC/KYB Applicant
      POST
    • Issue Card
      POST
    • Cards List
      GET
    • Get Card
      GET
    • Get Sensitive Card Details
      GET
  • Card Operations
    • Activate Card
      POST
    • Freeze Card
      POST
    • Unfreeze Card
      POST
    • Cancel Card
      POST
    • Replace Card
      POST
    • Set / Reset Card PIN
      POST
    • Get Card Limits
      GET
    • Update Card Limits
      POST
  • Funding
    • Top Up Card
      POST
    • Get Card Balance
      GET
    • List Top-Up History
      GET
  • Transactions
    • List All Transactions
      GET
    • List Card Transactions
      GET
    • List Customer Transactions
      GET
    • Get Transaction
      GET
  • Products
    • List Products
    • Get Product
  • Utilities
    • Upload Documents
  • Webhook's
    • Webhooks
  1. Customers

Create Customer

POST
{{baseUrl}}/api/v1/Customers
Creates a new customer record. Use type: "individual" for personal customers and type: "business" for company accounts.
Important notes:
email must be unique โ€” a 409 is returned if it already exists
date_of_birth and gender are required for individual customers
business_name should be provided for business customers
country uses ISO 3166-1 alpha-2 codes (e.g., "GB", "US", "AE")
external_reference lets you store your own system's customer ID for cross-referencing

๐Ÿ“‹ Request Body Fields#

โš ๏ธ Required Fields
FieldTypeDescriptionConstraints
typestringCustomer type. Must be individual or business. Example: individualPattern: `^(individual
first_namestringCustomer's first name. Example: JaneMax length: 100
last_namestringCustomer's last name. Example: DoeMax length: 100
emailstring (email)Unique email address. Cannot be updated after creation. Example: jane.doe@example.com-
phone_codestringInternational dialling code (e.g., +44, +1). Example: +44-
phone_numberstringPhone number without country code. Example: 7700900000-
countrystringCustomer's country of residence. ISO 3166-1 alpha-2 code (e.g., GB, US, AE). Example: GBMin length: 2 ยท Max length: 2
Optional Fields
FieldTypeDescriptionConstraints
business_namestringBusiness name (provide for business customers). Example: Acme Corp LtdNullable
date_of_birthstring (date-time)Required for individual customers. ISO 8601 format. Example: 1990-06-15T00:00:00ZNullable
genderstringRequired for individual customers. Common values: male, female, other. Example: femaleNullable
statestringState or region (optional). Example: EnglandNullable
external_referencestringYour internal customer ID for cross-referencing. Example: usr_12345Max length: 200 ยท Nullable

๐Ÿ“ค Response Fields#

FieldTypeDescriptionNotes
idstring (uuid)- Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6-
typestringindividual or business. Example: individual-
first_namestring- Example: Jane-
middle_namestring-nullable
last_namestring- Example: Doe-
emailstring- Example: jane.doe@example.com-
phone_codestring- Example: +44-
phone_numberstring- Example: 7700900000-
countrystring- Example: GB-
statestring-nullable
statusstringAccount status: active, suspended, closed. Example: active-
kyc_statestringKYC verification state: not_submitted, pending, approved, rejected. Example: approved-
date_of_birthstring (date-time)-nullable
genderstring-nullable
external_referencestring-nullable
businessobject-nullable
addressobject-nullable
created_atstring (date-time)--
updated_atstring (date-time)-nullable

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

๐ŸŸข201
application/json
Customer created successfully.
Body

๐ŸŸ 401
๐ŸŸ 409
๐ŸŸ 422
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location -g --request POST '{{baseUrl}}/api/v1/Customers' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "individual",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com",
    "phone_code": "+44",
    "phone_number": "7700900000",
    "date_of_birth": "1990-06-15T00:00:00Z",
    "gender": "female",
    "country": "GB",
    "state": "England",
    "external_reference": "usr_12345"
}'
Response Response Example
201 - Success
{
    "data": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "individual",
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "jane.doe@example.com",
        "phone_code": "+44",
        "phone_number": "7700900000",
        "country": "GB",
        "status": "active",
        "kyc_state": "not_submitted",
        "created_at": "2024-01-15T10:30:00Z"
    },
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
}
Modified atย 2026-02-18 13:16:45
Previous
API Setup Guide
Next
List Customers
Built with