Password expiry date

Intro

With this API, you can validate when a Buró de Crédito password will expire.

Important points

Request

To validate the password is necessary to provide the next fields

fieldtyperequiredlengthDescription
claveAlphanumericYes10User code provided by the credit bureau for a physical person.
contrasenaAlphanumericYes8Provide the currently active password.

Successful response

To know the fields of a successful response you should see our example called Result in the response section.

Inside the response object you will get the next field.

field NameDescription
fechaExpiracionIt will indicate the date on which your password will expire.
{
    "id": "658f622590fcb20e553c6d76",
    "createdAt": "2023-12-30T00:19:49.766566203Z",
    "finishedAt": "2023-12-30T00:19:50.297222502Z",
    "duration": 530,
    "status": "SUCCESS",
    "request": {
        "clave": "CO12345678",
        "contrasena": "12345678"
    },
    "apiData": [
        {
            "url": "128.9.55.100:25100",
            "duration": 194,
            "request": {
                "date": "2023-12-30T00:19:50.102464617Z",
                "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=\"getExpirationDate\"/>\n    </bc-request>\n</bc-request-envelope>"
            },
            "response": {
                "date": "2023-12-30T00:19:50.297167553Z",
                "body": {
                    "fechaExpiracion": "08/29/2022"
                },
                "httpCode": 200
            }
        }
    ],
    "response": {
        "fechaExpiracion": "08/29/2022"
    }
}

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:

  • get_expiration_date_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


🚧

change in test cases starting May 20, 2024

We inform you that starting May 20, 2024 we will make an update in the way of consuming our test cases, from now on, you must send the parameter testCaseId, indicating the identifier of the ID that is required to consult, for more information visit our knowledge center.

You can use any of the following testCaseId to test this service:

NumIdNameDescription
1663567bb713cf2110a110678Fecha de Expiración credenciales inválidasIndicates that the expiration date could not be obtained due to a credentials error
2663567bb713cf2110a110677Fecha de Expiración exitosoIndicates that the expiration date was successfully obtained

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"
    }
]

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": "contrasena"
    },
    {
        "code": "EMPTY_ERROR",
        "message": "can't be empty",
        "field": "clave"
    }
]

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"
    }
]

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.
Language
Authorization
Header
Click Try It! to start a request and see the response here!