Paths
/v1/customers/applicant/initial-profile/retrieve
To retrive the Risk level of a new To bank party in order to verify if he can apply for a new credit.
To retrieve the risk score of a new to bank party, which is evaluated in RCWS (Risk Calculation Web Service)
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
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel where request originated
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/risk/profile/retrieve
To retrieve the risk score of an existing bank party, which is evaluated in RCWS (Risk Calculation Web Service) in order to verify if the party could hire a new credit.
This API is used to retrieve the risk score of an existing bank party, which is evaluated in RCWS (Risk Calculation Web Service)
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
Country code in 2 character ISO 3166 format
Business code identified during application registration
Channel where request originated
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": {
"applicant": {
"$ref": "#/definitions/Applicant"
}
}
}
{
"type": "object",
"properties": {
"businessTypeCode": {
"description": "Type of business.",
"type": "string",
"example": "2394",
"maxLength": 8
},
"businessNature": {
"description": "Business nature of the applicant; Ex. CORP / ASSOCIATION.",
"type": "string",
"example": "CORP",
"maxLength": 20
},
"businessOwnerRange": {
"description": "Range about how many owners or partners the business has.",
"type": "string",
"example": "5 OR FEWER OWNERS"
},
"businessStockExchangeListingFlag": {
"description": "Flag to identify if the business is listed in stock exchange and is available for public trading.",
"type": "boolean",
"example": true
},
"applicationId": {
"description": "Banamex ID/ LocalID. Refers to the account opening folio for NTB (New to bank) accounts",
"type": "string",
"example": "5152243",
"maxLength": 30
},
"overseasTransactionFlag": {
"description": "Flag to specify whether it does overseas transaction.",
"type": "boolean",
"example": true
},
"industrySegment": {
"description": "Segment and Code of industry under which organization operates.",
"type": "string",
"example": "Institution",
"maxLength": 50
},
"kycNumber": {
"description": "KYC number of the customer. Required for RCWS",
"type": "string",
"example": "1234567890",
"maxLength": 100
},
"seniorPublicFigureFlag": {
"description": "Is applicant SPF or related to any SPF ( Senior Public Figure)",
"type": "boolean",
"example": true
},
"shareholderFlag": {
"description": "Bearer shares ind. Indicator that tells whether or not the company has shareholders.",
"type": "boolean",
"example": true
},
"incomeSource": {
"description": "Source Of Wealth",
"type": "string",
"example": "EMPLOYMENT",
"maxLength": 1024
},
"totalAssetsRange": {
"description": "Assets Under Management for Individual Customers.",
"type": "string",
"example": "1MM",
"maxLength": 4
},
"totalIncomeAmount": {
"description": "Total Income amount from all the sources.",
"type": "number",
"format": "double",
"example": 45000.55
},
"citizenshipCountryCode": {
"description": "The country in which a person is born (if person has not renounced or lost citizenship) or having the citizenship.",
"type": "string",
"example": "MX"
},
"organizationCategory": {
"description": "To inform if the organization belongs to the private industry or to the public service and if it is listed on stock exchange. For PyMEs, the organizations are always of the private industry and they are not listed on stock exchange.",
"type": "string",
"example": "Private"
},
"ownershipLevelCount": {
"description": "Beneficial Owner Layers. Total number of layers of the corporate group in which the owner(s) forms part of. For PyMes example: value = 1, because PyMEs doesn't have as owners other organizations (corporations).",
"type": "integer",
"format": "int32",
"example": 1
},
"ownershipPercentageRange": {
"description": "Beneficial Ownership Percentage, the percentage of the majority shareholder will be sent. Example: options for the value: LESS THAN 10%, BETWEEN 10%-24%, BETWEEN 25%-50%, BETWEEN 51%-99%, 100%",
"type": "string",
"example": "BETWEEN 10%-24%"
},
"beneficialOwnerCountry": {
"type": "array",
"items": {
"$ref": "#/definitions/BeneficialOwnerCountry"
}
}
},
"required": [
"businessTypeCode",
"folioId",
"industrySegment",
"kycNumber"
]
}
{
"type": "object",
"properties": {
"countryCode": {
"description": "Beneficial Owner Geographic Risk, country code of each owner.",
"type": "string",
"example": "MX"
}
}
}
{
"type": "object",
"properties": {
"riskRating": {
"description": "Code denoting level of risk of an applicant returned by RCWS.",
"type": "string",
"example": "L"
},
"riskScore": {
"description": "It is the score calculated based on customer behavior that RCWS gives the client.",
"type": "number",
"format": "double",
"example": 3.234
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer.",
"type": "string",
"example": "123456789012"
},
"customerType": {
"description": "Type of the customer. Example- Individual, Corporate.",
"type": "string",
"example": "INDIVIDUAL",
"maxLength": 12
},
"kycNumber": {
"description": "KYC number of the customer. Required for RCWS",
"type": "string",
"example": "1234567890",
"maxLength": 100
}
},
"required": [
"customerId",
"customerType",
"kycNumber"
]
}
{
"type": "object",
"properties": {
"riskRating": {
"description": "Risk rating of the customer. Example- L(Low) or HL(High Low) or HM(High medium) or HH(High high)",
"type": "string",
"example": "L",
"maxLength": 2
},
"riskScore": {
"description": "It is the score calculated based on customer behavior that RCWS gives the client.",
"type": "number",
"format": "double",
"example": 3.234
},
"customerType": {
"description": "Type of the customer. Example- Individual, Corporate.",
"type": "string",
"example": "INDIVIDUAL",
"maxLength": 12
},
"organizationType": {
"description": "Type of the organization. Example- HNW-RM, SMCORP, Bank, Mass market, etc.",
"type": "string",
"example": "SMCORP",
"maxLength": 12
}
}
}
{
"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": "More Info can be used to pass any additional details",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}