Intro
With this API, you can update a Buró de Crédito password.
Important points
Request
To validate the password is necessary to provide the next fields
| field | type | required | length | Description |
|---|---|---|---|---|
| clave | Alphanumeric | Yes | 10 | User code provided by the credit bureau for a physical person. |
| contrasena | Alphanumeric | Yes | 8 | Provide the currently active password. |
| nuevaContrasena | Alphanumeric | Yes | 8 | Provide the new password to assign. |
Successful response
To know the fields of a successful response you should see our example called Success in the response section.
Inside the response object you will get the next field.
| field Name | Description |
|---|---|
| nuevaContrasena | It will indicate the date new password that you assigned. |
{
"id": "658f6ab4cd93a9f6a929671f",
"createdAt": "2023-12-30T00:56:20.738194943Z",
"finishedAt": "2023-12-30T00:56:21.06604798Z",
"duration": 327,
"status": "SUCCESS",
"request": {
"clave": "CO12345678",
"contrasena": "12345678",
"nuevaContrasena": "P4ssw0rd"
},
"apiData": [
{
"url": "128.9.55.100:25100",
"duration": 196,
"request": {
"date": "2023-12-30T00:56:20.86937143Z",
"body":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<bc-request-envelope version=\"1.0\">\n <bc-request>\n <credentials member=\"CO12345678\" password=\"12345678\"/>\n <service name=\"changePassword\">\n <param name=\"old-password\" value=\"12345678\"/>\n <param name=\"new-password\" value=\"P4ssw0rd\"/>\n </service>\n </bc-request>\n</bc-request-envelope>"
},
"response": {
"date": "2023-12-30T00:56:21.066041399Z",
"body": {
"nuevaContrasena": "1hg8nwJG"
},
"httpCode": 200
}
}
],
"response": {
"nuevaContrasena": "1hg8nwJG"
}
}
Test the service (test cases)
We included a query param in Sandbox environment, so you can query test cases that we created to run tests.
In order to obtain the response you shall fill the query param with:
- change_password_success: it sends back a successful example.
Test your own test case
In case you want to test your own test case created in link, you can change the testCase parameter to testCaseId and send the identifier of the test case you want to use
Listing the possible NOT SUCCESS responses
Length error
You will get a 400 bad request error when the length of any of the parameters are not correct.
[
{
"code": "LENGTH_ERROR",
"message": "should be 10",
"field": "clave"
},
{
"code": "LENGTH_ERROR",
"message": "should be 8",
"field": "contrasena"
},
{
"code": "LENGTH_ERROR",
"message": "should be 8",
"field": "nuevaContrasena"
}
]
Empty Error
You will get a 400 bad request error when you nor provide any of the parameters.
[
{
"code": "EMPTY_ERROR",
"message": "can't be empty",
"field": "clave"
},
{
"code": "EMPTY_ERROR",
"message": "can't be empty",
"field": "contrasena"
},
{
"code": "EMPTY_ERROR",
"message": "can't be empty",
"field": "nuevaContrasena"
}
]
Format Error
You will receive a 400 bad request error if the data provided in any of the parameters does not match the required format.
[
{
"code": "FORMAT_ERROR",
"message": "should match following regex: ^([A-Z]{2}[A-Z\\d]{4}\\d{4})$",
"field": "clave"
},
{
"code": "FORMAT_ERROR",
"message": "must be alphanumeric",
"field": "contrasena"
},
{
"code": "FORMAT_ERROR",
"message": "must be alphanumeric",
"field": "nuevaContrasena"
}
]
Test case not found
If a test case parameter is not sent or a value other than those mentioned above is sent, the service will return the following error 400 bad request
[
{
"code": "EMPTY_ERROR",
"message": "test case not found",
"field": "testCase"
},
{
"code": "EMPTY_ERROR",
"message": "test case not found with given id",
"field": "testCaseId"
}
]
- testCase, It is because you did not send the name of a testCase that kiban has loaded by default, required in sandbox if you don't send testCaseId parameter.
- testCaseId, It is because you did not send the identifier of a testCase that you created in the test cases section within the kiban link tool, required in sandbox if you don't send testCase parameter.