Paths
/v1/customers/search/info/retrieve
LOB:Customer Data, Feature: Customer Ambiguity Functionality: Customer search details
Check the customer data and their Mongo and S016 accounts according to the combination of data in the search.
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Channel where request originated
Country code in 2 character ISO 3166 format
Business code identified during application registration
SessionId sent by Consumer
Successful operation.
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/customers/detailed-history/retrieve
LOB:Customer Data, Feature: Customer Ambiguity, Functionality: Customer Detailed History
This API queries the data of the additional customers returned by the first API according to their customerID since there may be customers with more than one customerID
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Channel where request originated
Country code in 2 character ISO 3166 format
Business code identified during application registration
SessionId sent by Consumer
Successful operation.
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"properties": {
"encryptedCustomerSearchInfoDetail": {
"type": "string",
"example": "WTq8zYcZfaWVvMncigHqwQ==",
"description": "Encrypted field containing validate object."
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer.",
"type": "string",
"example": "123456789012"
}
}
}
{
"type": "object",
"properties": {
"customerDetail": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerDetail"
}
}
}
}
{
"type": "object",
"properties": {
"customerDetail": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerInfo"
}
}
}
}
{
"type": "object",
"properties": {
"encryptedCustomerDetail": {
"description": "Encrypted field containing validate object.",
"type": "string",
"example": "WTq8zYcZfaWVvMncigHqwQ=="
}
}
}
{
"type": "object",
"properties": {
"encryptedCustomerInfoDetail": {
"description": "Encrypted field containing validate object.",
"type": "string",
"example": "WTq8zYcZfaWVvMncigHqwQ=="
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation or detailed description of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}