Regionalized Solutions
R24 AMR | Min(s) read
APIs
Please find below the API details for the Customer Compliance module.
The API will only be useable if the module has been licensed by the client.
In the URL, vx.x.x denotes the swagger version that client has licensed.
| Endpoint | Method | URL | Description |
|---|---|---|---|
| getIndividualCustomerSupplementaryInformation | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/individuals/details | To retrieve individual customer supplementary details with fields such as riskClassificationOnline. |
| addIndividualCustomerSupplementaryInformation | POST | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/individuals/details | To capture supplementary details of individual customer. |
| updateIndividualCustomerSupplementaryInformation | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/individuals/details/approvals | To update individual customer supplementary details with fields such as riskClassificationOnline. |
| createIndividualCustomer | POST | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/individuals | Create an individual customer with details such as name. |
| getIndividualCustomer | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/individuals | Retrieve an individual customer with details such as name. |
| updateIndividualCustomer | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/individuals | Update an individual customer with details such as name. |
| approveIndividualCustomer | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/individuals/approvals | Approve an individual customer with details such as name. |
| createCorporateCustomer | POST | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/corporates | Create a corporate customer with details such as name. |
| getCorporateCustomer | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/corporates | Retrieve a corporate customer with details such as name. |
| updateCorporateCustomer | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/corporates | Update a corporate customer with details such as name. |
| approveCorporateCustomer | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/corporates/approvals | Approve a corporate customer with details such as name. |
| getCorporateCustomerSupplementaryInformation | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/corporates/details | To retrieve additional details of a corporate customer that includes economic activities. |
| addCorporateCustomerSupplementaryInformation | POST | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/corporates/details | To capture additional details of a corporate customer that includes economic activities. |
| updateCorporateCustomerSupplementaryInformation | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/corporates/details | To update additional details of a corporate customer that includes economic activities. |
| approveCorporateCustomerSupplementaryInformation | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/{customerId}/corporates/details/approvals | To approve additional details of a corporate customer that includes economic activities. |
| createCorporateProspect | POST | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/corporates/prospects | Create prospect or entity for a corporate customer that includes company name. |
| approveCorporateProspect | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/corporates/prospects/{prospectId}/approvals | Approve prospect or entity for a corporate customer that includes company name. |
| updateCorporateProspect | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/corporates/prospects/{prospectId} | Update prospect or entity for a corporate customer that includes company name. |
| createIndividualProspect | POST | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/individuals/prospects | Create prospect or person for a individual customer that includes customer name. |
| approveIndividualProspect | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/individuals/prospects/{prospectId}/approvals | Approve prospect or person for a individual customer that includes customer name. |
| updateIndividualProspect | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/individuals/prospects/{prospectId} | Update prospect or person for a individual customer that includes customer name. |
| getProspectPersonEntityDetails | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/prospects/{prospectId} | Retrieve prospect or person entity details that includes company name. |
| getPersonEntitySupplementaryInformation | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/prospects/{prospectId}/details | To retrieve additional details of a person entity that includes legal entity key. |
| addEntitySupplementaryInformation | POST | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/corporates/prospects/{prospectId}/details | To captureadditional details of a entity that includes legal entity key. |
| updateEntitySupplementaryInformation | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/corporates/prospects/{prospectId}/details | To updateadditional details of a entity that includes legal entity key. |
| addPersonSupplementaryInformation | POST | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/individual/prospects/{prospectId}/details | To captureadditional details of a person that includes legal entity key. |
| updatePersonSupplementaryInformation | PUT | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/party/mx/customers/individual/prospects/{prospectId}/details | To updateadditional details of a person that includes legal entity key. |
| getMexicanScianCodes | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/reference/mx/economicGroups/industries | Retrieves the list of SCIAN codes (Sistema de Clasificación Industrial de América del Norte) which represents the demographic data and the characteristics of the people. |
| getMexicanEconomicSectors | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/reference/mx/economicGroups/sectors | Retrieves the list of economic sector code of CNBV (Comisión Nacional Bancaria y de Valores). |
| getMexicanRegulatoryCodes | GET | http://<hostname>:<jboss_port>/mxmb-provider-iris/api/vx.x.x/settings/mx/customers/externalCodes | Retrieves the list of regulatory codes pertaining to economic activities. |
In this topic