Customer Details

The Customer Details API allows you to retrieve detailed information about a customer's profile, including their onboarding progress, risk assessment status, and form completion status.

Authentication

All requests to this API require authentication using a bearer token in the Authorization header:

Authorization: Bearer your-token-here

For details on how to obtain an authentication token, please refer to the Authentication documentation.

Get Customer Details

GET {base_url}/ExtCustomerManagement/GetCustomerDetails/{submissionId}

Parameters

Parameter	Type	Required	Description
submissionId	string	Yes	The unique identifier of the customer submission

Response

{
  "version": null,
  "statusCode": 200,
  "messages": [
    "Processed successfully"
  ],
  "result": {
    "formId": "ffIn3438-63d4-443a-a4af-2336f58d1112",
    "formName": "Individual Customer Onboarding",
    "entityTypeId": "Individual",
    "accountStatusId": "Pending",
    "riskLevelId": "Low",
    "pendingStateId": "ClientInfoMissing",
    "onboardingProgress": 75.5,
    "onboardingStarted": "2023-06-15T10:30:01.96788Z",
    "onboardingCompleted": "2023-06-20T14:45:14.676302Z",
    "submissionClassification": "Retail",
    "approvalClassificationState": "Accepted",
    "overridenSubmissionClassification": null,
    "pageStatuses": [
      {
        "pageId": "page-1",
        "pageName": "Personal Information",
        "onboardingStatusId": "Completed"
      },
      {
        "pageId": "page-2",
        "pageName": "Address Details",
        "onboardingStatusId": "Completed"
      },
      {
        "pageId": "page-3",
        "pageName": "Document Upload",
        "onboardingStatusId": "Pending"
      }
    ]
  }
}

Response Fields

Field	Type	Description
formId	string	The identifier of the onboarding form
formName	string	The name of the onboarding form
entityTypeId	string	Type of entity ("Individual", "LegalEntity", or "IndividualJointAccount")
accountStatusId	string	Current account status (e.g., "Pending", "Approved", "Rejected")
riskLevelId	string	Risk level assessment result (e.g., "Low", "Medium", "High")
pendingStateId	string	Reason for pending status, if applicable
onboardingProgress	number	Percentage of onboarding completion (0-100)
onboardingStarted	datetime	When the onboarding process started
onboardingCompleted	datetime	When the onboarding process completed (null if not completed)
submissionClassification	string	Customer classification type (e.g., "Retail", "Professional")
approvalClassificationState	string	State of classification approval
overridenSubmissionClassification	string	The classification that has been requested by the customer
pageStatuses	array	Status of each onboarding page

Page Status Fields

Field	Type	Description
pageId	string	Unique identifier of the form page
pageName	string	Display name of the form page
onboardingStatusId	string	Status of the page ("Pending", "Locked", "Completed", "Unlocked")

Account Status Types

The customer account can have the following status values:

Status	Description
Pending	Account is awaiting review or completion
Approved	Account has been approved
Rejected	Account has been rejected
Frozen	Account has been temporarily suspended
Closed	Account has been closed
Dormant	Account is inactive

Risk Level Types

Risk assessment results can be one of the following values:

Risk Level	Description
Low	Low risk assessment
Medium	Medium risk assessment
High	High risk assessment
Prohibited	Customer is prohibited from using services
NA	Risk assessment not applicable or not completed

Pending State Types

When an account is in a pending status, it may have one of these pending state reasons:

Pending State	Description
ComplianceReview	Awaiting review by compliance team
InternalInfoMissing	Internal information needed to complete onboarding
ClientInfoMissing	Additional information needed from the client
Null	Customer has not completed the onboarding process

Classification Types

Customers can be classified as:

Classification	Description
Retail	Retail customer
Professional	Professional customer
MarketCounterParty	Market counterparty
NA	Classification not applicable or not determined

Error Handling

Status Code	Description	Solution
400	Submission not found	Check the submissionId format
401	Unauthorized access	Check authentication token or tenant permissions
429	Too many requests	Implement rate limiting