production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/party/profile-validation
post /v1/customers/party/profile-validation
validate-ine-information
To validate that customer information provided by the account executive exists and make match with the National Electoral Institute (INE for short in Spanish) database
This API validates that customer information provided by the account executive exists and make match with the National Electoral Institute (INE for short in Spanish) database
ClientID
X-IBM-Client-Id
(apiKey located in header)
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
Required in header
string
Client ID generated during application registration
client_secret
Optional in header
string
Client secret generated during application registration
Authorization
Optional 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 durin application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
Session is generated and returned on the first API call of the key exchange (GET e2e call) as response header, which needs to be resent on succesive calls of same session.
ineValidationRequest
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/party/profile-validation
Definitions
{
"type": "object",
"properties": {
"ipAddress": {
"description": "IP address of the client that summons this API",
"type": "string",
"example": "100.100.100.100",
"maxLength": 15
},
"branchId": {
"description": "Branch number where request was generated",
"type": "string",
"example": "2125",
"maxLength": 4,
"pattern": "^[0-9]{1,4}$"
},
"agentId": {
"description": "SOEID of the executive using this API",
"type": "string",
"example": "LP00987",
"maxLength": 8
},
"customer": {
"$ref": "#/definitions/Customer"
}
},
"required": [
"ipAddress",
"branchId",
"agentId"
]
}
{
"type": "object",
"properties": {
"consentGivenFlag": {
"description": "Consent of the client of being consulted",
"type": "boolean",
"example": true
},
"sourceSystem": {
"description": "Requests origin system",
"type": "string",
"example": "145850",
"maxLength": 6,
"pattern": "^[0-9]{1,6}$"
},
"lastName": {
"description": "lastName",
"type": "string",
"example": "PEREZ",
"maxLength": 32
},
"motherLastName": {
"description": "motherLastName",
"type": "string",
"example": "PEREZ",
"maxLength": 32
},
"firstName": {
"description": "Name",
"type": "string",
"example": "alejandra",
"maxLength": 32
},
"branchPostalCode": {
"description": "branchPostalCode",
"type": "string",
"example": "9010",
"maxLength": 5
},
"branchCity": {
"description": "branchCity",
"type": "string",
"example": "MEX.",
"maxLength": 20
},
"branchStateId": {
"description": "branchStateId",
"type": "integer",
"format": "int32",
"example": 15,
"maxLength": 2
},
"votingCard": {
"$ref": "#/definitions/VotingCard"
}
},
"required": [
"customerApproval",
"datacenterLocation",
"branchPostalCode",
"branchCity",
"branchStateId"
]
}
{
"type": "object",
"properties": {
"voterOcr": {
"description": "voterOcr",
"type": "string",
"example": "5391079564396",
"maxLength": 13
},
"voterCic": {
"description": "voterCic",
"type": "string",
"example": "987645321",
"maxLength": 10
},
"voterRegisterDate": {
"description": "voterRegisterDate",
"type": "string",
"example": "2008",
"maxLength": 4
},
"voterIssuanceYear": {
"description": "voterIssuanceYear",
"type": "string",
"example": "2016",
"maxLength": 4
},
"voterIssuance": {
"description": "voterIssuance",
"type": "string",
"example": "3",
"maxLength": 2
},
"voterId": {
"description": "voterId",
"type": "string",
"example": "VCMNDV89122915H900",
"maxLength": 18
},
"curp": {
"description": "curp",
"type": "string",
"example": "VIMD891229HMCCNV07",
"maxLength": 18
},
"fingerPrint1": {
"description": "fingerPrint1",
"type": "string",
"example": ""
},
"fingerPrint2": {
"description": "fingerPrint2",
"type": "string",
"example": ""
}
}
}
{
"type": "object",
"properties": {
"cecobanCode": {
"description": "cecobanCode",
"type": "string",
"example": "CRGEN000",
"maxLength": 10
},
"transactionDate": {
"description": "ineTransactionDate",
"type": "string",
"example": "2018-10-25T17:30:54.968",
"maxLength": 30
},
"transactionId": {
"description": "ineTransactionId",
"type": "string",
"example": "INCCA4A4352298D2V08HMRUI4",
"maxLength": 50
},
"responseCode": {
"description": "ineResponseCode",
"type": "string",
"example": "0",
"maxLength": 10
},
"requestId": {
"description": "SolicitudID-Unique request ID, in case of retry a request, it will be different",
"type": "string"
},
"customerData": {
"$ref": "#/definitions/CustomerData"
}
}
}
{
"type": "object",
"properties": {
"nameFlag": {
"description": "nameFlag",
"type": "boolean",
"example": true
},
"lastNameFlag": {
"description": "lastNameFlag",
"type": "boolean",
"example": true
},
"motherLastNameFlag": {
"description": "motherLastNameFlag",
"type": "boolean",
"example": true
},
"votingCardData": {
"$ref": "#/definitions/VotingCardData"
}
}
}
{
"type": "object",
"properties": {
"ocrFlag": {
"description": "ocrFlag",
"type": "boolean",
"example": true
},
"cicFlag": {
"description": "cicFlag",
"type": "boolean",
"example": true
},
"registerYearFlag": {
"description": "registerYearFlag",
"type": "boolean",
"example": true
},
"issuanceYearFlag": {
"description": "issuanceYearFlag",
"type": "boolean",
"example": true
},
"voterIssuanceFlag": {
"description": "voterIssuanceFlag",
"type": "boolean",
"example": true
},
"voterIdFlag": {
"description": "voterIdFlag",
"type": "boolean",
"example": true
},
"curpFlag": {
"description": "curpFlag",
"type": "boolean",
"example": true
}
}
}
{
"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"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}