Get Customer Details

Endpoint Overview

GET /api/v1/customer/{customer_id}

Description

This API endpoint retrieves detailed information about a specific customer using their unique customer ID. It provides comprehensive customer profile data including personal details, verification status, and associated documents. This endpoint is essential for accessing customer information for KYC (Know Your Customer) verification, customer service, and compliance purposes.

Key Benefits

Instant access to complete customer profile information

Streamlined customer verification and identity management

Simplified compliance with KYC and AML regulations

Reduced manual data retrieval efforts with a single API call

Use Cases

Financial Services

Insurance

Fintech

Retrieve customer details during loan application processing

Access customer verification status for account opening procedures

Verify customer identity before processing high-value transactions

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	JWT Bearer token for authentication. Format: `Bearer <your_token>`
Content-Type	Yes	Set to `application/json`

Path Parameters

Parameter	Type	Required	Description
customer_id	String	Yes	Unique identifier for the customer whose details are being requested

Request Body

This endpoint does not require a request body as it's a GET request.

Process Response

Response Parameters

Parameter	Type	Description
customer_id	String	Unique identifier of the Client
full_name	String	Full Name of the Customer
dob	Date	Date of Birth of the Customer
expiry	DateTime	Token expiry datetime
token	String	Token for Hosted KYC
hosted_link	String	Hosted KYC session link

Example Successful Response

{
  "customer_id": "CUST123456",
  "full_name": "John Doe",
  "dob": "1990-01-01",
  "expiry": "2025-05-15T18:30:00Z",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "hosted_link": "https://kyc.surepass.io/hosted/CUST123456"
}

Possible Error Responses

Customer Not Found

Authentication Error

{
  "status": "error",
  "error": {
    "code": "CUSTOMER_NOT_FOUND",
    "message": "The requested customer ID does not exist"
  }
}

This error occurs when the provided customer_id does not match any customer in the system.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement token refresh mechanisms to handle token expiration

Use HTTPS for all API communications to ensure data encryption

Implement proper error handling for authentication failures

User Experience Guidelines

Cache customer data when appropriate to reduce API calls and improve performance

Implement progressive loading for customer information in your UI

Display verification status clearly to end-users when relevant

Provide clear error messages to users when customer data cannot be retrieved

Code Samples

cURL

Python

Node.js

Related APIs

Create Customer API: Creates a new customer record in the system

Update Customer API: Updates existing customer information

Customer Document Upload API: Uploads verification documents for a customer

Customer Verification Status API: Checks the verification status of a customer

Compliance and Legal Considerations

When using this API to retrieve customer data, ensure compliance with data protection regulations such as GDPR, CCPA, or local data privacy laws. Customer data should only be accessed for legitimate business purposes with proper consent. Implement appropriate data retention and deletion policies in accordance with regulatory requirements.

{ "customer_id": "CUST123456", "full_name": "John Doe", "dob": "1990-01-01", "expiry": "2025-05-15T18:30:00Z", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "hosted_link": "https://kyc.surepass.io/hosted/CUST123456" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Get Customer Details

Get Customer Details#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Path Parameters#

Request Body#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Get Customer Details

Description

Use Cases

Technical Implementation

Request Headers

Path Parameters

Request Body

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples