1. Products
Artha All Module Api's
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Products
    • List Products
      GET
    • Get Product
      GET
    • Get Customer Product Status
      GET
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Submit Applicant (KYC/KYB)
      POST
    • Create Onboarding Session
      POST
  • Wallets
    • Beneficiary
      • Create Crypto Beneficiary
      • Update Crypto Beneficiary
      • List Crypto Withdraw Beneficiaries
    • Create Wallet
      POST
    • Get Wallet Address
      GET
    • Get Customer Balances
      GET
    • List Wallets
      GET
    • List Withdrawals
      GET
    • List Withdrawal Networks
      GET
    • Preview Withdrawal Summary
      POST
    • Create Crypto Withdrawal
      POST
  • Cards
    • Issuance
      • Issue Card
      • List Cards
      • List Customer Cards
      • Get Card Details
      • Get Sensitive Card Details
    • Funding
      • Top Up Card
      • Get Card Balance
      • Get Top-Up Status
      • List Top-Up History
    • Operations
      • Resend Activation Code
      • Activate Card
      • Set Card PIN
      • Change Card PIN
      • Update Card Limits
      • Freeze Card
      • Unfreeze Card
      • Replace Card
      • Cancel Card
      • Get Card Limits
      • Show Card PIN Details
      • Get PIN View Iframe URL
      • Get PIN Change Iframe URL
      • Get PIN Set Iframe URL
      • Get Card View Iframe URL
      • Show Card PIN
  • Payees
    • Create a payee for a customer.
      POST
    • List a customer's payees.
      GET
    • Update a payee.
      PUT
    • Retrieve a payee by id.
      GET
    • Look up an existing payee.
      GET
    • List the currencies a payee can be created in.
      GET
    • List the accepted payment purpose codes for a payee.
      GET
    • List the countries a payee can be created in.
      GET
    • List currency/country pairings for payees.
      GET
    • List the accepted beneficiary relationship codes.
      GET
  • Payments
    • Onboarding
      • List the customer's payout-currency configuration sections.
      • Enable a payout-currency section for the customer.
      • Get the customer's terms-of-service acceptance status.
      • Enable or disable a payout-currency section.
    • Quote
      • List the currencies a beneficiary can be paid in under a product.
      • List the payout rails available for a product and beneficiary.
      • Create an FX quote giving the rate and fee for a cross-currency payout.
    • Order
      • Submit a payout order to send money to a beneficiary.
      • Retrieve the on-chain address to fund an order.
      • Retrieve the status and settlement detail of a payout order.
    • Lookups
      • List the accepted payment purpose codes for a payout.
      • List the accepted source-of-funds codes for a payout.
      • List the document types accepted on a payout order.
  • Banks
    • Accounts
      • Create Bank Account
      • Get Account Details
      • Get Account Issuance Status
    • Withdraw
      • Create Withdrawal Quote
      • List Withdrawal Purposes
      • Get Payment Schemes
      • Execute Withdrawal
  • Exchange
    • Quote
      • Get Exchange Rate
      • Create Price Quote
    • Order
      • Place Exchange Order
  • Transactions
    • List Transactions
    • Get Transaction Details
  • Utilities
    • List Currencies
    • List Countries
    • Get Fee Schedule
    • List Product Occupations
    • List Product Industry Codes
    • Upload File
  • Webhook's
    • Wallets Webhooks
    • Banks Webhooks
    • Payments Webhooks
    • Exchange Webhooks
    • Card Webhooks
  1. Products

Get Customer Product Status

GET
/api/v1/products/{productId}/customerStatus/{customerId}
Returns a customer's onboarding state for a specific product. Poll this after Submit Applicant or
Create Onboarding Session until the customer reaches Approved.
Status values (customerStatus)
StatusMeaning
DraftOnboarding started but nothing submitted
PendingCreated, KYC not yet submitted
SubmittedDetails submitted to the provider
UnderReviewVerification in progress
NeedInformationMore information or documents required
ApprovedCustomer verified and active on this product
RejectedApplication rejected
CancelledApplication cancelled
FailedVerification failed
customerStatus can be null when the customer has not started onboarding for the product at all.
Response Fields (inside data)
FieldTypeDescription
customerIdstring (uuid)The customer this status applies to
productIdstring (uuid)The product this status applies to
fullNamestring, nullableCustomer's full name
emailstring, nullableCustomer's email
customerStatusstring, nullableKYC state for this product - see the table above
This call reports the customer's own status. Applications submitted for an employee (with employeeId)
are not reflected here.

Request

Path Params

Header Params

Responses

🟢200
application/json
Customer product status retrieved successfully.
Bodyapplication/json

🟠401
🟠404
🟠422
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/products/b1f3c7a2-6c4e-4d91-9f2a-123456789abc/customerStatus/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'X-Idempotency-Key;'
Response Response Example
200 - Verification in progress
{
    "data": {
        "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "productId": "b1f3c7a2-6c4e-4d91-9f2a-123456789abc",
        "fullName": "Jane Doe",
        "email": "jane.doe@example.com",
        "customerStatus": "UnderReview"
    },
    "requestId": "9f2c4b6e8a1d4f0cb7e35a91d2c46f80",
    "timestamp": "2026-08-22T10:30:00.123Z"
}
Modified at 2026-08-22 04:49:45
Previous
Get Product
Next
Create Customer
Built with