Customer Profile Management

The Customer Profile Management APIs enable you to create, retrieve, and manage customer profiles for both individuals and legal entities. These APIs support comprehensive KYC processes and customer data management.

Overview

The API suite provides endpoints for:

• Creating customer profiles
• Retrieving profile information
• Managing customer credentials
• Downloading profile reports
• Managing customer documents

Creating Customer Profiles

Add Individual Customer

POST {base_url}/ExtCustomerManagement/AddCustomer

Request Body

{
  "userType": "IndividualCustomer",
  "customerEmail": "johndoe@yopmail.com",
  "customerMobileNumber": "",
  "employeeId": "3ea657a9-5a05-46f9-9277-d27f2ccd13ea",
  "formId": "ffIn3438-63d4-443a-a4af-2336f58d1112",
  "clientId": "5b2a1c84-9d77-4e1a-a8b3-2f9a45d6c901",
  "sendEmail": true,
  "individualCustomer": {
    "firstName": "John",
    "lastName": "Doe"
  }
}

Add Legal Entity

{
  "userType": "LegalCustomer",
  "customerEmail": "company@yopmail.com",
  "customerMobileNumber": "",
  "employeeId": "3ea657a9-5a05-46f9-9277-d27f2ccd13ea",
  "formId": "ffIn3438-63d4-443a-a4af-2336f58d1112",
  "clientId": "5b2a1c84-9d77-4e1a-a8b3-2f9a45d6c901",
  "sendEmail": true,
  "legalEntityCustomer": {
    "fullName": "Company Name Ltd",
    "registrationNumber": "12345",
    "tradingName": "Trading Name"
  }
}

Request Parameters

Parameter	Type	Required	Description
userType	string	Yes	"IndividualCustomer" or "LegalCustomer"
customerEmail	string	Yes	Customer's email address
employeeId	string	Yes	ID of the employee creating the profile
formId	string	Yes	Onboarding form identifier
clientId	string	No	ID of the client the new profile should be assigned to. Must belong to your tenant. If omitted, the profile is assigned to the tenant's default client.
sendEmail	boolean	Yes	Whether to send welcome email

Response

{
  "version": null,
  "statusCode": 200,
  "messages": [
    "Processed successfully"
  ],
  "result": {
    "submissionId": "ab98babe-b555-4b79-88bf-967f454df0c0"
  }
}

Retrieving Profiles

Get Individual Profile

GET {base_url}/ExtReport/GetIndividualProfile/{submissionId}

Get Legal Entity Profile

GET {base_url}/ExtReport/GetLegalProfile/{submissionId}

Response Structure

{
  "version": null,
  "statusCode": 0,
  "messages": null,
  "result": {
    "form": {},
    "submission": {},
    "answers": [],
    "riskAssessment": {},
    "riskAssessmentDetail": {},
    "documents": []
  }
}

Response Fields

Field	Description	Type
form	Onboarding form details	Object
submission	User submission details	Object
answers	Form answers	Array
riskAssessment	Risk assessment results	Object
documents	Uploaded documents	Array

Downloading Profile Reports

Get Individual Profile PDF

GET {base_url}/ExtReport/DownloadIndividualProfilePagePdf/{submissionId}

Get Legal Entity Profile PDF

GET {base_url}/ExtReport/DownloadLegalProfilePagePdf/{submissionId}

Managing Customer Credentials

Set Customer Password

POST {base_url}/ExtCustomerManagement/SetCustomerPassword

Request Body

{
  "userType": "IndividualCustomer",
  "submissionId": "ab98babe-b555-4b79-88bf-967f454df0c0"
}

Employee Management

Get All Employees

GET {base_url}/ExtCustomerManagement/GetEmployees

Response

{
  "version": null,
  "statusCode": 200,
  "messages": ["Processed successfully"],
  "result": [
    {
      "id": "3ea657a9-5a05-46f9-9277-d27f2ccd13ea",
      "name": "Employee Name"
    }
  ]
}

Best Practices

1. Profile Creation:

   • Validate all input data
   • Implement proper error handling
   • Store submissionId securely
   • Implement retry logic for failures

2. Data Management:

   • Regular profile updates
   • Periodic risk reassessment
   • Document version control
   • Audit trail maintenance

3. Security:

   • Secure credential management
   • Access control implementation
   • Data encryption
   • Regular security audits

Rate Limits

• Profile creation: 10 requests per minute
• Profile retrieval: 60 requests per minute
• Document downloads: 30 requests per minute

Webhooks

Profile updates can trigger webhook notifications. See Webhook Integration for configuration details.