Permite identificar si una persona natural o jurídica tiene productos embargables en alguna de las filiales del Grupo Bancolombia.
- Protocols: HTTPS
Base Gateway API Endpoint
Paths
/attachment-accounts
Existencia de cuentas embargables.
Capacidad que permite identificar si un cliente Bancolombia tiene productos embargables.
Expone los formularios para validar la identidad y autorización del usuario.
Datos necesarios para realizar la petición.
Success Response.
Error in the request.
Incorrect credentials.
You do not have permissions to access the resource.
Resource not found.
Resource state has conflicts with data of the request.
Internal server error.
Error in the service provider response.
Service unavailable.
Service provider response time exceeded.
Unexpected Error.
Capacidad que permite identificar si un cliente Bancolombia tiene productos embargables.
Expone los formularios para validar la identidad y autorización del usuario.
200 OK
Definitions
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"customerDocumentType",
"customerDocumentNumber"
],
"properties": {
"customerDocumentType": {
"type": "string",
"description": "Tipo de identificación de la persona.",
"example": "CC",
"enum": [
"CC",
"CE",
"NIT",
"PAS"
]
},
"customerDocumentNumber": {
"type": "string",
"description": "Número de identificación de la persona con dígito de verificación cuando aplique.",
"example": "15290489",
"maxLength": 16,
"minLength": 5
}
}
}
}
}
}
{
"properties": {
"header": {
"$ref": "#\/definitions\/headerData"
},
"subsidiaries": {
"type": "array",
"items": {
"$ref": "#\/definitions\/resSubsidiaries"
}
},
"links": {
"$ref": "#\/definitions\/topLevelLinks"
}
},
"additionalProperties": false
}
{
"properties": {
"subsidiaryNit": {
"type": "string",
"description": "Número de identificación tributario de la filial (NIT) con dígito de verificación.",
"example": "800987678",
"maxLength": 11,
"minLength": 11
},
"subsidiaryName": {
"type": "string",
"description": "Nombre de la filial.",
"example": "Bancolombia Panamá",
"maxLength": 80,
"minLength": 3
},
"productAttachable": {
"type": "boolean",
"description": "Campo que retorna verdadero si el cliente tiene al menos un producto embargable en la filial.",
"example": "true"
}
},
"additionalProperties": false
}
Meta-información no estándar que no se puede representar con datos.
{
"type": "object",
"required": [
"_messageId",
"_version",
"_requestDate"
],
"properties": {
"_messageId": {
"type": "string",
"example": "c4e6bd04-5149-11e7-b114-b2f933d5fe66"
},
"_version": {
"type": "string",
"example": "1.0"
},
"_requestDate": {
"type": "string",
"format": "date-time",
"example": "2019-08-26T05:00:00.000Z"
},
"_responseSize": {
"type": "integer",
"example": 1
},
"_clientRequest": {
"type": "string",
"example": "acxff62e-6f12-42de-9012-3e7304418abd"
}
}
}
El "tipo" y "id" para cada registro.
{
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"example": "Customers"
},
"id": {
"type": "string",
"example": "Customer-2019-08-26T05:00:00.000Z"
}
},
"additionalProperties": false
}
URLs relacionadas con los datos primarios.
{
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/links"
}
]
}
Un objeto de recurso PUEDE contener referencias a otros objetos de recurso
{
"type": "object",
"properties": {
"self": {
"description": "Un mismo miembro, cuyo valor es una URL para los datos de relación",
"type": "string",
"format": "uri"
},
"related": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
{
"type": "object",
"required": [
"meta",
"errors"
],
"properties": {
"meta": {
"$ref": "#\/definitions\/meta"
},
"errors": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#\/definitions\/error"
}
}
},
"additionalProperties": false
}
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"id": {
"description": "Un identificador único para esta aparición particular del problema.",
"type": "string",
"example": "5f2d287a-3a3f-11e7-a919-92ebcb67fe33"
},
"href": {
"description": "Un URI que ** PUEDE ** proporciona más detalles sobre esta ocurrencia particular del problema.",
"type": "string",
"example": "https:\/\/tools.ietf.org\/html\/rfc7231#section-6.5.4"
},
"status": {
"description": "El código de estado HTTP aplicable a este problema, expresado como un valor de cadena.",
"type": "string",
"example": 404
},
"code": {
"description": "Un código de error específico de la aplicación, expresado como un valor de cadena.",
"type": "string",
"example": "BP404"
},
"title": {
"description": "Un breve resumen, legible por el hombre, del problema. ** NO DEBE ** cambiar de ocurrencia a ocurrencia del problema, excepto para propósitos de localización.",
"type": "string",
"example": "Not Found"
},
"detail": {
"description": "Una explicación legible por humanos específica para esta ocurrencia del problema.",
"type": "string",
"example": "Requested resource could not be found"
}
},
"additionalProperties": false
}