Skip to main content

Customer Service

Verifies customer existence.


Endpoints


Verify Customer

GET /customers/:customerId

Verify if a customer exists.

Path Parameters

ParameterTypeRequiredDescriptionExample
customerIdstringYesThe ID of the customer to verify"cst-123e4567-e89b-12d3-a456-426614174000"

Request Body (optional)

FieldTypeRequiredDescriptionExample
routerDataobjectYesRouter-specific configuration data{ "connectionType": "SOAP" }

Example Request:

{
"routerData": {
"connectionType": "SOAP",
"endpoint": "https://bank-api.example.com/soap"
}
}

Success Response

Returns customer verification status.

{
"customerId": "cst-123e4567-e89b-12d3-a456-426614174000",
"status": true
}

Error Responses

  • 404 Not Found: Customer not found
  • 400 Bad Request: Invalid customer ID or request format

Error Format

All error responses follow this format:

{
"statusCode": "ERROR_CODE",
"error": ["Description of the error"],
"requestId": "72e32108-6260-45e9-bb12-325fe3b61e42",
"path": "endpoint path",
"timestamp": "2025-11-19T16:32:57.915Z"
}

Field Descriptions

FieldTypeDescription
customerIdstringUnique identifier for the customer
statusbooleanWhether the customer exists (true or false)
routerDataobjectRouter-specific configuration data (optional)

For more details, see CustomerController definition.