production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/party
post /v1/customers/party
create-party
Saves party's information for first time
Create the register for a party person
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
stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}createPartyRequest
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
put /v1/customers/party
update-party
Updtes party's information
Updates the register for a party person
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
stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}updatePartyRequest
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
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party
/v1/customers/{customerId}/party
get /v1/customers/{customerId}/party
retrieve-all-party-details
Retrieve the party's information
Get all party's information details just sending the client id.
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
customerId
Required in path
string
Customer Id
stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}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
GET https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/{customerId}/party
Definitions
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "CSI where the request goes",
"type": "string",
"example": "04",
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"party": {
"$ref": "#/definitions/Party"
}
}
}
{
"type": "object",
"properties": {
"aliasName": {
"description": "alias Name or business alias name",
"type": "string",
"example": "Telmex",
"maxLength": 55
},
"americanTaxId": {
"description": "Tax Id where the member pay taxes",
"type": "string",
"example": "COPER3344525",
"maxLength": 20
},
"fullName": {
"description": "Full name or business name",
"type": "string",
"example": "Telefonos de Mexico SA de CV",
"maxLength": 170
},
"taxId": {
"description": "Tax Id in Mexico",
"type": "string",
"example": "COMS883992AZ4",
"maxLength": 20
},
"curp": {
"description": "Type of goverment Id number, CURP",
"type": "string",
"example": "BEML920313HMCLNS09",
"maxLength": 18
},
"curpValidated": {
"description": "Field to know if CURP has been validated",
"type": "string",
"example": "V",
"maxLength": 1,
"pattern": "^[A-Z]*$"
},
"emailAddress": {
"description": "Member's eMail",
"type": "string",
"example": "ejemp@hotmail.com",
"maxLength": 26
},
"partyType": {
"description": "Person Type of the member",
"type": "string",
"example": "01",
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"fiel": {
"description": "Electronic signature for pay taxes in Mexico",
"type": "string",
"example": "33edfghhrrfe454543rgfdg3433678899vf",
"maxLength": 20
},
"seniorPublicFigureType": {
"description": "Value to indicate if person is public figure or a VIP. Value can change depending on type or figure or person (president, senator, governor, etc)",
"type": "integer",
"example": 1,
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"branchId": {
"description": "Branch number",
"type": "string",
"example": "0034",
"maxLength": 4,
"pattern": "^\\d{4}$"
},
"structuredAddress": {
"type": "array",
"items": {
"$ref": "#/definitions/StructuredAddress"
}
},
"demographics": {
"$ref": "#/definitions/Demographics"
},
"phone": {
"type": "array",
"items": {
"$ref": "#/definitions/Phone"
}
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/Employment"
}
}
},
"required": [
"aliasName",
"fullName"
]
}
{
"type": "object",
"properties": {
"party": {
"$ref": "#/definitions/PartyDetail"
}
}
}
{
"type": "object",
"properties": {
"errorMessage": {
"description": "Message from S016 system if something went wrong",
"type": "string",
"example": "No data was inserted in some dialogs"
}
}
}
{
"type": "object",
"properties": {
"aliasName": {
"description": "alias Name or business alias name",
"type": "string",
"example": "Telmex"
},
"americanTaxId": {
"description": "Tax Id where the member pay taxes",
"type": "string",
"example": "COPER3344525"
},
"fullName": {
"description": "Full name or business name",
"type": "string",
"example": "Telefonos de Mexico SA de CV"
},
"taxId": {
"description": "Tax Id in Mexico",
"type": "string",
"example": "COMS883992AZ4"
},
"curp": {
"description": "C.U.R.P.",
"type": "string",
"example": "BEML920313HMCLNS09"
},
"curpValidated": {
"description": "Field to know if CURP has been validated",
"type": "string",
"example": "V"
},
"fiel": {
"description": "Electronic signature for pay taxes in Mexico",
"type": "string",
"example": "33edfghhrrfe454543rgfdg3433678899vf"
},
"emailAddress": {
"description": "Member's eMail",
"type": "string",
"example": "ejemp@hotmail.com"
},
"seniorPublicFigureType": {
"description": "Value to indicate if person is public figure or a VIP. Value can change depending on type or figure or person (president, senator, governor, etc)",
"type": "integer",
"example": 1
},
"partyType": {
"description": "Person Type of the member",
"type": "string",
"example": "01",
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"partyId": {
"description": "Member number for Identification",
"type": "string",
"example": "4439992"
},
"branchId": {
"description": "Branch number",
"type": "string",
"example": "034"
},
"structuredAddress": {
"type": "array",
"items": {
"$ref": "#/definitions/StructuredAddress"
}
},
"phone": {
"type": "array",
"items": {
"$ref": "#/definitions/Phone"
}
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/Employment"
}
},
"demographics": {
"$ref": "#/definitions/Demographics"
}
},
"required": [
"aliasName",
"fullName",
"partyId"
]
}
{
"type": "object",
"properties": {
"addressType": {
"description": "Description whether the addess is local or foreign",
"type": "string",
"example": "Foreign",
"maxLength": 8
},
"streetName": {
"description": "Name of the street and Ext. number and Int. number",
"type": "string",
"example": "Calle de los remedios No. 18",
"maxLength": 36
},
"colonyName": {
"description": "Colony name of the address",
"type": "string",
"example": "La Lupita",
"maxLength": 24
},
"municipalityName": {
"description": "Name of the municipality",
"type": "string",
"example": "Acambay",
"maxLength": 20
},
"stateCode": {
"description": "State code or federal entity of the address",
"type": "string",
"example": "0013",
"maxLength": 4,
"pattern": "^\\d{4}$"
},
"postalCode": {
"description": "Postal code or zip code of the address",
"type": "string",
"example": "90210",
"maxLength": 10
},
"countryCode": {
"description": "Code of the country",
"type": "string",
"example": "0036",
"maxLength": 4,
"pattern": "^\\d{4}$"
}
},
"required": [
"streetName",
"colonyName",
"municipalityName",
"stateCode",
"postalCode",
"countryCode"
]
}
{
"type": "object",
"properties": {
"nationality": {
"description": "The status of belonging to a particular nation, whether by birth or naturalization",
"type": "string",
"example": "1",
"maxLength": 1,
"pattern": "^\\d{1}$"
},
"countryOfBirth": {
"description": "Country code where person has born.",
"type": "string",
"example": "'00004321",
"maxLength": 8,
"pattern": "^\\d{8}$"
},
"gender": {
"description": "Gender/Sex - Male, Female, Other for the member",
"type": "string",
"example": "1",
"maxLength": 1,
"pattern": "^\\d{1}$"
},
"stateOfBirthName": {
"description": "This entity stores the basic demographic details of the applicant",
"type": "string",
"example": "0021",
"maxLength": 4,
"pattern": "^\\d{4}$"
},
"dateOfBirth": {
"description": "Date of birth of the member",
"type": "string",
"format": "date",
"example": "1995-12-07",
"maxLength": 10
},
"secondNationalCountryCode": {
"description": "Country of the nationality",
"type": "string",
"example": "00000003",
"maxLength": 8,
"pattern": "^\\d{8}$"
},
"taxDomicileCountryCode": {
"description": "Foreign country where the member pay taxes",
"type": "string",
"example": "0014",
"maxLength": 4,
"pattern": "^\\d{4}$"
}
},
"required": [
"dateOfBirth"
]
}
{
"type": "object",
"properties": {
"phoneNumber": {
"description": "Telephone of contact for the member",
"type": "string",
"example": "72228237390",
"maxLength": 10,
"pattern": "^\\d{10}$"
},
"extensionNumber": {
"description": "Extension number",
"type": "string",
"example": "332",
"maxLength": 6,
"pattern": "^\\d{6}$"
},
"phoneType": {
"description": "Type of telephone",
"type": "string",
"maxLength": 2,
"example": "13",
"pattern": "^\\d{2}$"
},
"operatorName": {
"description": "Phone Company",
"type": "string",
"example": "0021",
"maxLength": 4,
"pattern": "^\\d{4}$"
}
}
}
{
"type": "object",
"properties": {
"occupationName": {
"description": "Work id or business id",
"type": "string",
"example": "36",
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"businessSectorName": {
"description": "Name of the business sector",
"type": "string",
"example": "000321",
"maxLength": 6,
"pattern": "^\\d{6}$"
}
}
}
{
"type": "object",
"properties": {
"partyId": {
"description": "Member number for Identification",
"type": "string",
"example": "4439992",
"maxLength": 12,
"pattern": "^\\d{12}$"
},
"errorMessage": {
"description": "Message from S016 system if something went wrong",
"type": "string",
"example": "No data was inserted in some dialogs"
}
},
"required": [
"partyId"
]
}
{
"type": "object",
"properties": {
"party": {
"$ref": "#/definitions/PartyInformation"
}
}
}
{
"type": "object",
"properties": {
"aliasName": {
"description": "Alias Name or business alias name",
"type": "string",
"example": "Telmex"
},
"americanTaxId": {
"description": "Tax Identification Number of the organization in a foreign country",
"type": "string",
"example": "ASSFD7883992aade"
},
"partyType": {
"description": "PersonType of the member",
"type": "string",
"example": "Fisica"
},
"fullName": {
"description": "Full name or business name",
"type": "string",
"example": "Telefonos de Mexico SA de CV"
},
"taxId": {
"description": "Tax Id where the member pay taxes",
"type": "string",
"example": "COPER3344525"
},
"curp": {
"description": "C.U.R.P.",
"type": "string",
"example": "BEML920313HMCLNS09"
},
"curpValidated": {
"description": "Field to know if CURP has been validated",
"type": "string",
"example": "V"
},
"fiel": {
"description": "Electronic signature for pay taxes in Mexico",
"type": "string",
"example": "33edfghhrrfe454543rgfdg3433678899vf"
},
"seniorPublicFigureType": {
"description": "Value to indicate if person is public figure or a VIP. Value can change depending on type or figure or person (president, senator, governor, etc)",
"type": "integer",
"example": 1
},
"partyId": {
"description": "Member number for Identification",
"type": "string",
"example": "4439992"
},
"emailAddress": {
"description": "Member's eMail",
"type": "string",
"example": "ejemp@hotmail.com"
},
"branchId": {
"description": "Branch number",
"type": "string",
"example": "034"
},
"structuredAddress": {
"type": "array",
"items": {
"$ref": "#/definitions/StructuredAddress"
}
},
"employment": {
"type": "array",
"items": {
"$ref": "#/definitions/Employment"
}
},
"demographics": {
"$ref": "#/definitions/Demographics"
},
"phone": {
"type": "array",
"items": {
"$ref": "#/definitions/Phone"
}
}
},
"required": [
"aliasName",
"fullName",
"partyId"
]
}
{
"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"
]
}