production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/applicant/initial-profile/retrieve
post /v1/customers/applicant/initial-profile/retrieve
retrieve-applicant-initial-profile
To retrive the Risk level of a new To bank party.
To retrieve the risk score of a new to bank party, which is evaluated in RCWS (Risk Calculation Web Service)
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
RetrieveAplInitProfileRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| 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 |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/applicant/initial-profile/retrieve
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
},
"businessOwnerCount": {
"description": "Total number of owners or partners of the business.",
"type": "string",
"example": "WIDELY HELD CORPORATION",
"maxLength": 80
},
"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
},
"totalAssets": {
"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
}
},
"required": [
"businessTypeCode",
"folioId",
"industrySegment"
]
}
{
"type": "object",
"properties": {
"riskLevel": {
"description": "Code denoting level of risk of an applicant returned by RCWS.",
"type": "string",
"example": "L"
},
"riskRating": {
"description": "It is the score calculated based on customer behavior that RCWS gives the client.",
"type": "number",
"format": "double",
"example": 47790
}
}
}
{
"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"
]
}