bcs-policy-management-api-services
home
API INFORMATION
Title: policy-management-api-services
Last Version: 1.5.34
Protocols: HTTPS
URI Sandbox:
URI QA:
URILive:
DESCRIPTION
The API will offer consumers to create the insurance policy, manage the insurance statement systems and submit the final policy statement using criteria related to the product number, allowing the following operations:
Summary
-Status Submit:
Description: Keep the bank's systems updated with the statuses generated in visual time for each case.
Path:
POST /policy-management/v1/status-submit
Request information:
request:
source: Bank Origin System
statusCode: Application Status
depAcctStmtRec:
depAcctId:
acctId: Credit Application Number / application
personInfo:
govIssueIdent:
identSerialNum: Identification number
govIssueIdentType: Id type identification
personType: Applicant Type
policy:
signature
issDt: Insurability date
status: Client status
descriptionDesc: Observation
pmtsPlanProdType: Assigned Plan
product:
productType: Product Type
covered:
coveredCode: Amparo Code
exclude: Excluded
insurancePremiumAmt: Extra premium percentageResponse information:
depAcctStmtRec:
depAcctId
refNumber: Credit Application Number / applicationgovIssueIdent:
govIssueIdentType: Id type
identSerialNum: Identification number> Example of Body to Response Successfull.
{
"responseType": {
"value": "OK"
},
"depAcctStmtRec":{
"depAcctId":{
"refNumber": "550100000001028"
},
},
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
}
}> Response Error.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "00001",
"errorDesc": "Error en el enviar estado de la solicitud",
"errorType": "TPS"
}
}-Status Update:
Description: This operation allows updating case information.
PUT
/policy-management/v1/status-update:Mapping Request
| Field BCS (campo) | Description(Descripcion) | Type (Tipo) | Pattern / Min-Max value / Dictionary-Enum | Required(Requerido) |
|---|---|---|---|---|
| request.source | Sistema Origen del Banco | string | ^[ñAa-zA-z,0-9_ ,\W]*$ , minLength: 0 , maxLength: 1 | YES |
| request.statusCode | Estado de la Solicitud | String - enum | SE AP NE DE NR AE AG CM PC AN AV DI FS IT PE PS SO | YES |
| depAcctStmtRec.depAcctId.acctId | Numero Solicitud Credito | String | ^[ñAa-zA-z,0-9_ ,\W]*$ , minLength: 0 , maxLength: 15 | YES |
| product.producType | Tipo producto | String | ^[ñAa-zA-z,0-9_ ,\W]*$ ,minLength: 0 , maxLength: 4 | YES |
| personInfo.govIssueIdent.govIssueIdentType | Tipo Identificación. | String - enum | CC CE PA TI NI PE | YES |
| personInfo.govIssueIdent.identSerialNum | Número de Identificación | String | minLength: 0 , maxLength: 30 | YES |
| personInfo.personType | Tipo solicitante | String | ^[ñAa-zA-z,0-9_ ,\W]*$ ,minLength: 0 , maxLength: 15 | NO |
| personInfo.policy.signature.issDt | Fecha de asegurabilidad | dateTime | YYYY-MM-DD | YES |
| personInfo.policy.status | Estado del cliente | String - enum | SE AP NE DE NR AE AG CM PC AN AV DI FS IT PE PS SO | YES |
| personInfo.policy.descriptionDesc | Causa Justificacion Observación | String | ^[ñAa-zA-z,0-9_ ,\W]*$ , minLength: 0 , maxLength: 200 | YES |
| personInfo.policy.pmtsPlanProdType | Plan Asignado | String | ^[ñAa-zA-z,0-9_ ,\W]*$ , minLength: 0 , maxLength: 3 | NO |
| personInfo.policy.exclude | Requiere ExtraPrima | String - enum | false true , minLength: 1 , maxLength: 5 | NO |
| personInfo.policy.Percentage | Porcentaje Extra Prima | String | ^[0-9]*$ ,minLength: 1 , maxLength: 5 | NO |
| coverageInfo[].coverageId | Código de Amparo | String | ^[Aa-zA-z,0-9_ ,\W]*$ , maxLength: 10 | NO |
| coverageInfo[].exclude | Excluido | Boolean | NO | |
| coverageInfo[].percentage | Porcentaje Prima | String | maxLength: 3 | NO |
| insuranceInfo.coveredCode | Case number | String | ^[0-9]*$ | YES |
Mapping request example:
{
"request": {
"source": "1",
"statusCode": "AP"
},
"depAcctStmtRec": {
"depAcctId": {
"acctId": "550100000000001"
}
},
"personInfo": {
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
},
"personType": "1",
"policy": {
"signature": {
"issDt": "1967-02-26"
},
"status": "AE",
"descriptionDesc": "1",
"pmtsPlanProdType": "1",
"exclude": "true",
"percentage": "10"
}
},
"product": {
"productType": "0"
},
"coverageInfo": [
{
"exclude": true,
"percentage": "S",
"coverageId": "2"
}
],
"insuranceInfo": {
"coveredCode": "1"
},
"sequenceProductRequested": "111"
}
Mapping Response OK
| Campo | Descripcion | Tipo | Longitud |
|---|---|---|---|
| depAcctStmtRec.depAcctId.refNumber | Número de la solicitud | String | 15 |
| govIssueIdent.govIssueIdentType | Tipo Identificación. | String | 3 |
| govIssueIdent.identSerialNum | Número Identificación | String | 15 |
Mapping response example:
{
"depAcctStmtRec": {
"depAcctId": {
"refNumber": "550100000001028"
}
},
"govIssueIdent": {
"identSerialNum": "1234567890",
"govIssueIdentType": "CC"
}
}Mapping Response Error
> Mapping Response Error.
| Campo | Descripcion | Tipo |
|---|---|---|
| responseType.value | Tipo de Respuesta | String |
| responseDetail.errorCode | Código de Error. Ejemplo: “200” | String |
| responseDetail.errorDesc | Descripción de Error Ejemplo: “Consulta Exitosa” | String |
| responseDetail.errorType | Tipo de Error | String |
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "00001",
"errorDesc": "Error en la actualizacion",
"errorType": "TPS"
}
}statusCode table:
| Concepto | Credito 6 | S4U | Visual Time |
|---|---|---|---|
| Aprobado | AP | AP | |
| Negado | NE | NE | |
| Negado Relacionado | NR | NR | |
| Autorización exámenes médicos | AE | n/a | |
| Agendamiento exámenes médicos | AG | n/a | |
| Agendamiento exámenes médicos | CM | n/a | |
| pendiente calificación | PC | n/a | |
| Proceso en seguros | SE | SE | |
| siniestro entrada analizar y evaluar caso | n/a | AN | |
| siniestro esperando documento | n/a | AV | |
| Desistido | n/a | DE | |
| Documentación Incompleta | n/a | DI | |
| formalización del siniestro | n/a | FS | |
| interrupción de términos | n/a | IT | |
| pendiente evaluación | n/a | PE | |
| pago del siniestro | n/a | PS | |
| siniestro objetado después de 60 días | n/a | SO |
Client status table
| Estado del cliente |
|---|
| SE |
| AP |
| NE |
| DE |
| NR |
> Diagram of sequence.
- Insurance Case Create :
Description: This operation allows receives information from the bank to start the process of creating insurability cases in VT
Path:
POST
/policy-management/v1/insurance/case:Request information:
| Campo | MAPPER (cs-visual-time-sapi) | DESCRIPCIÓN | TIPO | LONGITUD | Requerido |
|---|---|---|---|---|---|
| channel | Object | ||||
| channel.sPname | Domain | El nombre de dominio es el que envía la información. | String | 15 | YES |
| channel.user | UserName | El usuario que envía la información para crear el caso | String | 10 | YES |
| insuranceInfo[] | Cases[] | Información sobre los casos. | Array | YES | |
| insuranceInfo[].desc | Cases[].Process | Por defecto, viene como GestionDeExamenesMedicos | String | 30 | YES |
| insuranceInfo[].refInfo[] | Cases[].Entities | Array | YES | ||
| insuranceInfo[].refInfo[].curAmt.amt | Cases[].Entities[].ApprovedAmount | Monto de valor que se aprueba para el credito | float | 15 | YES |
| insuranceInfo[].refInfo[].cityId | Cases[].Entities[].City | Ciudad de donde llega la solicitud | String | 5 | YES |
| insuranceInfo[].refInfo[].relationshipType | Cases[].Entities[].PortfolioType | Si el producto es individual o colectivo. | Int | 2 | YES |
| insuranceInfo[].refInfo[].createdDt | Cases[].Entities[].CreationDate | Fecha de creación de la solicitud. Formato aaaa-mm-dd. | Date | aaaa-mm-dd. | YES |
| insuranceInfo[].refInfo[].requestNumber | Cases[].Entities[].RequestNumber | Número de solicitud enviado por el banco. | int | 15 | YES |
| insuranceInfo[].refInfo[].submitOffice.branchId | Cases[].Entities[].Office | Bank branch. | String | 5 | YES |
| insuranceInfo[].refInfo[].trnSrcInfo.code | Cases[].Entities[].BankSystemOrigin | Int | 1 | YES | |
| insuranceInfo[].refInfo[].productType | Cases[].Entities[].ProductType | Opciones de tipo de producto: 3701 Vida Individual (acsel/x), 3703 Deudor Individual (BCS), 34VD Deudor Colectivo (BCS). | String | 4 | YES |
| insuranceInfo[].refInfo[].flagAutom | Cases[].Entities[].AutomaticRequest | Campo que evalúa si la solicitud ha sido creada automáticamente o no. El valor por defecto para este campo debería ser “Verdadero” (True). | Boolean | YES | |
| insuranceInfo[].refInfo[].applicantInfo[] | Cases[].Entities[].Applicants[] | Informacion de los solicitantes | Array | YES | |
| insuranceInfo[].refInfo[].applicantInfo[].personName.firstName | Cases[].Entities[].Applicants[].FirstName | Nombre de pila del solicitante. | String | 20 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].personName.middleName | Cases[].Entities[].Applicants[].SecondName | Segundo nombre del solicitante. | String | 20 | NO |
| insuranceInfo[].refInfo[].applicantInfo[].personName.lastName | Cases[].Entities[].Applicants[].FirstLastName | Apellido del solicitante. | String | 20 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].personName.secondLastName | Cases[].Entities[].Applicants[].secondLastName | Segundo apellido del solicitante. | String | 20 | NO |
| insuranceInfo[].refInfo[].applicantInfo[].govIssueIdent.identSerialNum | Cases[].Entities[].Applicants[].Identification | Número de identificación del solicitante. | Int | 15 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].govIssueIdent.govIssueIdentType | Cases[].Entities[].Applicants[].IdentificationType | Tipo de identificación del solicitante. | String | 3 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].applicantType | Cases[].Entities[].Applicants[].ApplicantType | Si se trata de un caso individual, se guardará como 1-Titular principal. | int | 1 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].planRequested | Cases[].Entities[].Applicants[].PlanRequested | Guardar el plan al que pertenece el solicitante. | String | 3 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].personInfo.birthDt | Cases[].Entities[].Applicants[].ApplicantDetails.Birthdate | Fecha de nacimiento del solicitante. Formato AAAA-MM-DD. | Date | AAAA-MM-DD | YES |
| insuranceInfo[].refInfo[].applicantInfo[].orgInfo.addr1 | Cases[].Entities[].Applicants[].ApplicantDetails.WorkAddress | Dirección de trabajo del solicitante. | String | 45 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].orgInfo.cityId | Cases[].Entities[].Applicants[].ApplicantDetails.WorkCity | Ciudad de trabajo del solicitante. | String | 5 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].contactInfo.cellPhone | Cases[].Entities[].Applicants[].ApplicantDetails.CellPhoneNumber | Número de teléfono celular del solicitante. | Int | 10 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].contactInfo.cityId | Cases[].Entities[].Applicants[].ApplicantDetails.City | Ciudad del solicitante. | String | 5 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].profile | Cases[].Entities[].Applicants[].ApplicantDetails.Profile | Perfil del solicitante. | Int | 1 | NO |
| insuranceInfo[].refInfo[].applicantInfo[].personInfo.gender | Cases[].Entities[].Applicants[].ApplicantDetails.Gender | Género del solicitante. | String | 1 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].birthDt | Cases[].Entities[].Applicants[].ApplicantDetails.InsurabilityDate | Por defecto, se envía la misma fecha de nacimiento. Formato AAAA-MM-DD. | Date | AAAA-MM-DD. | YES |
| insuranceInfo[].refInfo[].applicantInfo[].contactInfo.emailAddr | Cases[].Entities[].Applicants[].ApplicantDetails.Email | Dirección de correo electrónico del solicitante. | String | 50 | NO |
| insuranceInfo[].refInfo[].applicantInfo[].contactInfo.additionalphoneNum.cellPhone | Cases[].Entities[].Applicants[].ApplicantDetails.HomePhoneNumber | Número de teléfono fijo del hogar del solicitante. | Int | 7 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].contactInfo.addr1 | Cases[].Entities[].Applicants[].ApplicantDetails.HomeAddress | Dirección del solicitante. | String | 45 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].orgInfo.additionalPhoneNum.cellPhone | Cases[].Entities[].Applicants[].ApplicantDetails.WorkPhoneNumber | Número de teléfono del trabajo del solicitante. | Int | 7 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].businessOcucupation.certcode | Cases[].Entities[].Applicants[].ApplicantDetails.Occupation | Ocupación del solicitante. | Int | 4 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].question[] | Cases[].Entities[].Applicants[].ApplicantDetails.InsurabilityStatement[] | Preguntas sobre la información de la declaración de asegurabilidad del solicitante. | Array | YES | |
| insuranceInfo[].refInfo[].applicantInfo[].question[].questionIdent | Cases[].Entities[].Applicants[].ApplicantDetails.InsurabilityStatement[].QuestionId | Código de la pregunta. | Int | 2 | YES |
| insuranceInfo[].refInfo[].applicantInfo[].question[].answer | Cases[].Entities[].Applicants[].ApplicantDetails.InsurabilityStatement[].Answer | Respuesta TRUE - FALSE. | Boolean | TRUE/FALSE | YES |
| insuranceInfo[].refInfo[].applicantInfo[].question[].desc | Cases[].Entities[].Applicants[].ApplicantDetails.InsurabilityStatement[].Comments | Si existen observaciones. | String | 200 | YES |
> Example of Body to Request Successfull.
{
"channel": {
"sPname": "domain",
"user": "admon"
},
"insuranceInfo": [
{
"desc": "GestionDeExamenesMedicos",
"refInfo": [
{
"curAmt": {
"amt": 50000000
},
"cityId": "11001",
"relationshipType": 1,
"createdDt": "1967-02-26",
"requestNumber": 1216827820,
"submitOffice": {
"branchId": "0166"
},
"trnSrcInfo": {
"code": 6
},
"productType": "34VO",
"flagAutom": true,
"applicantInfo": [
{
"personName": {
"firstName": "DORA",
"middleName": "NELLY",
"lastName": "RESTREPO",
"secondLastName": "HERRERA"
},
"personInfo":{
"birthDt": "1967-02-26",
"gender": "1"
},
"govIssueIdent": {
"identSerialNum": 10003598,
"govIssueIdentType": "CC"
},
"applicantType": 1,
"planRequested": "001",
"orgInfo": {
"addr1": "KR 1 12 66",
"cityId": "81001",
"additionalPhoneNum": {
"cellPhone": 7403462
}
},
"contactInfo": {
"cellPhone": 3212587913,
"cityId": "11001",
"emailAddr": "s9m3b9o7@bancocajasocial.com",
"additionalPhoneNum": {
"cellPhone": 4296111
},
"addr1": "KR 22 06 32"
},
"profile": 0,
"birthDt": "1967-02-26",
"businessOcucupation": {
"certcode": "05"
},
"question": [
{
"questionIdent": 1,
"answer": true,
"desc": ""
},
{
"questionIdent": 2,
"answer": false,
"desc": ""
},
{
"questionIdent": 3,
"answer": false,
"desc": ""
},
{
"questionIdent": 4,
"answer": false,
"desc": ""
},
{
"questionIdent": 5,
"answer": false,
"desc": ""
}
]
}
]
}
]
}
]
}
Response information:
| Campo | MAPPER (cs-visual-time-sapi) | DESCRIPCIÓN | TIPO |
|---|---|---|---|
| insuranceInfo.policyId | CaseId | Numero del caso | String |
| insuranceInfo.trnSrcInfo.Code | BankSystemId | Origen de la aplicación del banco. | Int |
| insuranceInfo.requestNumber | RequestId | Número de solicitud. | Int |
| insuranceInfo.productType | BankProductId | Tipos de productos 3701 Vida Individual – 3703 Individual Deudor 34VD (colectivo). | String |
| insuranceInfo.startDt | TransactionTimesTamp | Marca de tiempo de la transacción | Date |
| insuranceInfo.responseType.value | cabeceraSalida.tipoRespuesta | Devuelve el estado de la transaccion | String |
| insuranceInfo.responseDetail.errorCode | cabeceraSalida.respuestaError.codigoError | Devuelve codigo de error encontrado | String |
| insuranceInfo.responseDetail.errorDesc | cabeceraSalida.respuestaError.descripcionError | Descripción del error | String |
| insuranceInfo.responseDetail.errorType | cabeceraSalida.respuestaError.tipoError | Tipo de error devuelto | String |
| insuranceInfo.refInfo.spRefId | respuestaSolicitudCaso.proceso.codigo | Código del item | String |
| insuranceInfo.refInfo.validityTime | respuestaSolicitudCaso.proceso.numeroRadicado | Duración del proceso | String |
| insuranceInfo.refInfo.statusDesc | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.estado | Estado del proceso | String |
| insuranceInfo.refInfo.effDt | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.fechaEstimadaSolucion | Fecha en la cual se estima la solución | String |
| insuranceInfo.refInfo.startDt | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.itemTrabajofechaIngreso | Fecha de ingreso de item | String |
| insuranceInfo.refInfo.applicantInfo.spRefId | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.codigo | Codigo perteneciente a la tarea | String |
| insuranceInfo.refInfo.applicantInfo.amt | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.costo | Costo asignado a la tarea | String |
| insuranceInfo.refInfo.applicantInfo.desc | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.descripcion | Descripción de la tarea | String |
| insuranceInfo.refInfo.applicantInfo.validityPeriod | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.duracionEstimada | Estimacón de la duración | String |
| insuranceInfo.refInfo.applicantInfo.orgInfo.desc | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.nombre | Nombre de la tarea asiganada Ejmplo. "CancelarCaso" | String |
| insuranceInfo.refInfo.applicantInfo.orgInfo.desc2 | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.nombrePantalla | Nombre de la pantalla | String |
| insuranceInfo.refInfo.applicantInfo.priority | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.prioridad | Prioridad asignada a la tarea - "Normal" | String |
| insuranceInfo.refInfo.applicantInfo.orgInfo.message | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.textoAyuda | Texto de apoyo para la ayuda | String |
| insuranceInfo.refInfo.applicantInfo.orgInfo.refType | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.tarea.tipo | Tipo de la tarea - "Event | String |
| insuranceInfo.name | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.mensajesGuardados.entidades | Entidades correspondientes a un mensaje | String |
| insuranceInfo.flagScreen | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.clasePantalla | Definición del Flujo de Trabajo | String |
| insuranceInfo.applicantInfo.code | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.codigo | Código del flujo | String |
| insuranceInfo.applicantInfo.desc | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.descripcion | Descripción del flujo de trabajo | String |
| insuranceInfo.applicantInfo.startDt | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.fechaCreacion | Fecha de Creación del flujo | String |
| insuranceInfo.applicantInfo.externalId | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.llaveGlobal | Llave Global del flujo de trabajo, identificador único de 35 caracteres alfanumerico | String |
| insuranceInfo.applicantInfo.mainLocation | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.localizacionPrincipal | Determinación del Flujo principal de trabajo. Para este caso "FIFO" | String |
| insuranceInfo.applicantInfo.name | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.nombre | Nombre del flujo de trabajo - GestionDeExamenesMedicos | String |
| insuranceInfo.applicantInfo.desc2 | cabeceraSalida.itemsTrabajo.itemTrabajo.flujoTrabajo.nombrePantalla | Identificador del nombre de la pantalla asignada al flujo de trabajo- "Gestión de exámenes médicos" | String |
| insuranceInfo.applicantInfo.order | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.ordenPantalla | Orden en el cual se asigna la pantalla | String |
| insuranceInfo.applicantInfo.refType | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.tipo | Descripción del tipo del flujo de trabajo | String |
| insuranceInfo.applicantInfo.itemGeneric1 | cabeceraSalida.proceso.itemsTrabajo.itemTrabajo.flujoTrabajo.usoPatronRadicacion | Tipo de uso de patron de radicación - Process | String |
Response information:
> Example of Body to Response Successfull.
{
"insuranceInfo": {
"policyId": 23032220,
"trnSrcInfo": {
"code": "1"
},
"requestNumber": "14516",
"productType": "3704",
"transactionTimestamp": "2023-12-12T19:43:23.9152169-05:00",
"responseType": {
"value": "OK"
},
"responseDetail": {
"errorCode": "",
"errorDesc": "",
"errorType": ""
},
"refInfo": {
"spRefId": "3606690",
"validityTime": "0",
"statusDesc": "Inactive",
"effDt": "2023-12-12T19:43:23.9152169-05:00",
"startDt": "",
"applicantInfo": {
"spRefId": "160",
"amt": "0",
"desc": "",
"validityPeriod": "0",
"priority": "Normal",
"orgInfo": {
"desc": "CancelarCaso",
"desc2": "nombrePantalla",
"message": "",
"refType": "Event"
}
}
},
"name": "",
"flagScreen": "True",
"applicantInfo": {
"code": "1",
"desc": "",
"startDt": "2023-12-13T00:43:36.778Z",
"externalId": "55f198d7-2ddf-4bdb-b1ad-c03d4b303fa",
"mainLocation": "FIFO",
"name": "GestionDeExamenesMedicos",
"desc2": "Gestión de exámenes médicos",
"order": "1",
"refType": "",
"itemGeneric1": "Process"
}
}
}
Response Error mapping
| Campo | Descripcion | Tipo |
|---|---|---|
| responseType.value | Tipo de Respuesta | String |
| responseDetail.errorCode | Código de Error. Ejemplo: “200” | String |
| responseDetail.errorDesc | Descripción de Error Ejemplo: “Consulta Exitosa” | String |
| responseDetail.errorType | Tipo de Error | String |
> Response Error.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "00001",
"errorDesc": "Error en la actualizacion",
"errorType": "TPS"
}
}
- [Life] Simulation :
Description: This service allows you to create a Life Insurance Simulation (xAPI)
Path: [ Method: POST ]
/policy-management/v1/life/simulation:
Request [] information:
[
product:
productIdNumber (Required) : Contains information of product identifier eg. :
24297 = Tu Ingreso Protegido
27298 = Tu Ahorro Amigo
31300 = AP Individual Banco Caja Socia
insuranceInfo:
channel (Required) : Contains information of Sale Channel Id , eg:
101 = Directo
102 = Consultores Neg. Institucional
103 = Corredores
104 = FVD Consumo
105 = Agencias
106 = Agentes
107 = Hall Bancario
108 = Telemercadeo
109 = Corresponsal Individual
110 = Medios Virtuales
111 = Licitaciones
112 = Afinidad
113 = FVD Microfinanzas
114 = Oficinas
115 = Aplicación Móvil
116 = Mercadeo Directo
117 = Corresponsal Convenios
118 = FVD Hipotecario
119 = FVD Libranzas <br>
120 = FVD Tarjeta de Crédito
121 = Consultores Riesgos Laborales
personName:
birthDt (Required) : Contains information of insured's date of birth .
]> Request example.
[
{
"product": {
"productIdNumber": "24297"
},
"insuranceInfo": {
"channel": "101",
"personName": {
"birthDt": "30-12-1990"
}
}
},
{
"product": {
"productIdNumber": "31300"
},
"insuranceInfo": {
"channel": "109",
"personName": {
"birthDt": "25-10-1980"
}
}
}
]
>Response information:
responseDetail:
errorCode: Contains information of Error code
errorDesc: Contains information of Error description
startDt: Contains information of transaction timestamp
insuranceInfo[]:
product:
productLine: Contains information of business line code
productClass: Contains information of product identifier
coverageId: Contains information of module code.
desc: Contains information of module description.
fee:
totalInsurableValue: Contains information of total premium
freq: Contains information of premium payment frequency code:
1 = Anual
2 = Semestral
3 = Trimestral
4 = Bimestral
5 = Mensual
6 = Único
8 = Cuotas
10000 = Indefinido
7 = Diaria
coverageInfo []:
coverageId: Contains information of coverage id
desc: Contains information of coverage description
amt: Contains information of fixed amount insured
fee:
insuranPremiumValue: Contains information of fixed premium
insuranPremiumValue: Contains information of Annual Premium Amount.
> Example of Body to Response Successfull.
{
"responseDetail": {
"errorCode": "",
"errorDesc": "",
"startDt": "2023-07-19T10:28:27.0131805-05:00"
},
"insuranceInfo": [
{
"product": {
"productLine": 31,
"productClass": 31300,
"idItem": 1,
"desc": "Plan 1 5 MM",
"fee": {
"totalInsurableValue": 200
},
"freq": 1
},
"coverageInfo": [
{
"coverageId": 1,
"desc": "Muerte Accidental",
"amt": 5000000.0,
"fee": {
"insuranPremiumValue": 0.0
},
"insuranPremiumValue": 59880.0
},
{
"coverageId": 2,
"desc": "Incapacidad Total y Permanente Accidental",
"amt": 0.0,
"fee": {
"insuranPremiumValue": 0.0
},
"insuranPremiumValue": 0.0
}
]
},
{
"product": {
"productLine": 31,
"productClass": 31300,
"idItem": 2,
"desc": "Plan 2 10 MM",
"fee": {
"totalInsurableValue": 300
},
"freq": 2
},
"coverageInfo": [
{
"coverageId": 1,
"desc": "Muerte Accidental",
"amt": 10000000.0,
"fee": {
"insuranPremiumValue": 0.0
},
"insuranPremiumValue": 83880.0
},
{
"coverageId": 2,
"desc": "Incapacidad Total y Permanente Accidental",
"amt": 0.0,
"fee": {
"insuranPremiumValue": 0.0
},
"insuranPremiumValue": 0.0
}
]
}
]
}
> Response Error.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "",
"errorDesc": "",
"errorType": ""
}
}
- [Life] Quote :
Description: This service allows you to create a Life Insurance Quote (xAPI)
Path: [ Method: POST ]
/policy-management/v1/life/quote:
Request [] information:
[
productIdnumber:
Contains information of product code:
24297 = Tu Ingreso Protegido
27298 = Tu Ahorro Amigo
31300 = AP Individual Banco Caja Socia
freq:
1 = Anual
2 = Semestral
3 = Trimestral
4 = Bimestral
5 = Mensual
6 = Único
8 = Cuotas
10000 = Indefinido
7 = Diaria
channel
101 = Directo
102 = Consultores Neg. Institucional
103 = Corredores
104 = FVD Consumo
105 = Agencias
106 = Agentes
107 = Hall Bancario
108 = Telemercadeo
109 = Corresponsal Individual
110 = Medios Virtuales
111 = Licitaciones
112 = Afinidad
113 = FVD Microfinanzas
114 = Oficinas
115 = Aplicación Móvil
116 = Mercadeo Directo
117 = Corresponsal Convenios
118 = FVD Hipotecario
119 = FVD Libranzas
120 = FVD Tarjeta de Crédito
121 = Consultores Riesgos Laborales
cityId
421 = Bucaramanga principal
1001 = Dirección General
2013 = Ibagué
2016 = Bogotá
2017 = Yopal
2018 = Villavicencio
2026 = Neiva
2029 = Duitama
3004 = Barranquilla
3014 = Valledupar
3015 = Cartagena
3023 = Santa Marta
4003 = Medellín
4006 = Pereira
4011 = Manizales
4021 = Armenia
4025 = Montelibano
4027 = Montería
5002 = Cali
5008 = Buenaventura
5019 = Pasto
5022 = Popayán
6005 = Bucaramanga
coverageId
1 = 24 24297 Plan 1 500K 4 Cuotas
2 = 24 24297 Plan 2 700K 4 Cuotas
3 = 24 24297 Plan 3 900K 4 Cuotas
4 = 24 24297 Plan 4 1.2M 4 Cuotas
5 = 24 24297 Plan 5 500K 6 Cuotas
6 = 24 24297 Plan 6 700K 6 Cuotas
7 = 24 24297 Plan 7 900K 6 Cuotas
8 = 24 24297 Plan 8 1.2M 6 Cuotas
1 = 24 24298 Plan 1 100K 6 Cuotas
2 = 24 24298 Plan 2 200K 6 Cuotas
3 = 24 24298 Plan 3 300K 6 Cuotas
4 = 24 24298 Plan 4 400K 6 Cuotas
1 = 31 31300 Plan 1 $5 MM
2 = 31 31300 Plan 2 $10 MM
3 = 31 31300 Plan 3 $5 MM Asist
4 = 31 31300 Plan 4 $10 MM Asist
5 = 31 31300 Plan 5 $25 MM
6 = 31 31300 Plan 6 $50 MM
7 = 31 31300 Plan 7 $25 MM Asist
8 = 31 31300 Plan 8 $50 MM Asist
9 = 31 31300 Plan 9 $75 MM
10 = 31 31300 Plan 10 $100 MM
11 = 31 31300 Plan 11 $75 MM Asist
12 = 31 31300 Plan 12 $100 MM Asist
13 = 31 31300 Plan 13 $125 MM
14 = 31 31300 Plan 14 $150 MM
15 = 31 31300 Plan 15 $125 MM Asist
16 = 31 31300 Plan 16 $150 MM Asist
personType
1 = Persona Natural
2 = Empresa (Persona Jurídica)
govIssueIdentType
1 = N.I.T.
2 = Cédula de Ciudadanía
3 = Cédula de Extranjería
4 = Tarjeta de Identidad
5 = Pasaporte
6 = Registro Civil
7 = Registro Médico
8 = N.U.I.P.
9 = C.I.I.U.
10 = P.E.P
11 = Provisional
12 = Permiso Protección Temporal
Gender
1 = Femenino
2 = Masculino
3 = No informado
PhoneType
1 = Oficina
2 = Celular
3 = Fax
4 = Particular
5 = Otros
6 = Contacto
]> Request example.
{
"product": {
"productIdNumber": 31300,
"freq": 1
},
"entprAgreement": {
"cityId": "6005"
},
"coverageInfo": {
"coverageId": 1
},
"insuranceInfo": {
"personType": 1,
"channel": 101,
"govIssueIdent": {
"govIssueIdentType": 3,
"identSerialNum": "300541"
},
"personName": {
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"birthDt": "19-03-1970",
"gender": 1
},
"contactInfo": [
{
"emailAddr": "TESTE@GMAIL.COM",
"phoneNum": [
{
"phoneType": 4,
"phoneAreaCode": 55,
"phone": "11999999999"
},
{
"phoneType": 2,
"phoneAreaCode": 55,
"phone": "11999999999"
}
]
}
],
"coverageInfo": [
{
"coverageId": 1,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 3,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"additionalData": [
{
"coverageId": 1,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 3,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 1,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"listValidation": [
{
"coverageId": 1,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 3,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 1,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
]
},
"identVerifyEntity": [
{
"idItem": 100391531,
"rate": 50,
"order": 1
},
{
"idItem": 100150827,
"rate": 50,
"order": 1
}
],
"additionalData": [
{
"key": "SecondName",
"value": "Pedro"
}
]
}
>Response information:
pmtReferences:
pmtAuthId: Contains information of pmtAuthId
responseDetail:
errorCode: Contains information of Error code
errorDesc: Contains information of Error description
startDt: Contains information of transaction timestamp
insuranceInfo:
coverageInfo[]:
coverageId: Contains information of coverageId
validityPeriod: Contains information of validityPeriod
validityTime: Contains information of validityTime
amt: Contains information of amt
rate: Contains information of rate
ccAcctRec:
brand: Contains information of brand
rate: Contains information of rate
amt: Contains information of amt
insuranPremiumValue: Contains information of insuranPremiumValue
desc: Contains information of desc
additionalData:
type: Contains information of type
amt: Contains information of amt
invoicePremium:
fee:
totalInsurableValue: Contains information of Net premium
amt: Contains information of amt
billId: Contains information of billId
insuranPremiumValue: Contains information of premium
> Example of Body to Response Successfull.
{
"pmtReferences": {
"pmtAuthId": 0
},
"responseDetail": {
"errorCode": "",
"errorDesc": "",
"startDt": ""
},
"insuranceInfo": {
"coverageInfo": [
{
"coverageId": 0,
"validityPeriod": 0,
"validityTime": 0,
"amt": 0.0,
"rate": 0.0,
"ccAcctRec": {
"brand": 0,
"rate": 0.0,
"amt": 0.0
},
"insuranPremiumValue": 0,
"desc": "",
"additionalData": [
{
"type": 0,
"amt": 0.0
}
]
}
]
},
"invoicePremium": {
"fee": {
"totalInsurableValue": 0.0,
"amt": 0.0
},
"billId": 0,
"insuranPremiumValue": 0.0
}
}
> Response Error.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "",
"errorDesc": "",
"errorType": ""
}
}
...
- [Life] issuing :
Description: This service allows you to create a Life Insurance issuing
Path: [ Method: POST ]
/policy-management/v1/life/issuing:
Request [] information:
product:
productIdNumber(Required) : Contains information of product identifier:
24297 = Tu Ingreso Protegido
27298 = Tu Ahorro Amigo
3130 = AP Individual Banco Caja Socia
freq(Required) : Contains information of product identifier:
1 = Anual
2 = Semestral
3 = Trimestral
4 = Bimestral
5 = Mensual
6 = Único
8 = Cuotas
10000 = Indefinido
7 = Diaria
entprAgreement:
cityId(Required) : Contains information of city identifier:
421 Bucaramanga principal
1001 Dirección General
2013 Ibagué
2016 Bogotá
2017 Yopal
2018 Villavicencio
2026 Neiva
2029 Duitama
3004 Barranquilla
3014 Valledupar
3015 Cartagena
3023 Santa Marta
4003 Medellín
4006 Pereira
4011 Manizales
4021 Armenia
4025 Montelibano
4027 Montería
5002 Cali
5008 Buenaventura
5019 Pasto
5022 Popayán
6005 Bucaramanga
pmtReferences:
pmtAuthId (Required) : Quote code, take the value that the quote returns
pmtType (Required) : pay method
coverageInfo:
coverageId (Required) : Coverage module identifier :
24 24297 1 Plan 1 500K 4 Cuotas
24 24297 2 Plan 2 700K 4 Cuotas
24 24297 3 Plan 3 900K 4 Cuotas
24 24297 4 Plan 4 1.2M 4 Cuotas
24 24297 5 Plan 5 500K 6 Cuotas
24 24297 6 Plan 6 700K 6 Cuotas
24 24297 7 Plan 7 900K 6 Cuotas
24 24297 8 Plan 8 1.2M 6 Cuotas
24 24298 1 Plan 1 100K 6 Cuotas
24 24298 2 Plan 2 200K 6 Cuotas
24 24298 3 Plan 3 300K 6 Cuotas
24 24298 4 Plan 4 400K 6 Cuotas
31 31300 1 Plan 1 $5 MM
31 31300 2 Plan 2 $10 MM
31 31300 3 Plan 3 $5 MM Asist
31 31300 4 Plan 4 $10 MM Asist
31 31300 5 Plan 5 $25 MM
31 31300 6 Plan 6 $50 MM
31 31300 7 Plan 7 $25 MM Asist
31 31300 8 Plan 8 $50 MM Asist
31 31300 9 Plan 9 $75 MM
31 31300 10 Plan 10 $100 MM
31 31300 11 Plan 11 $75 MM Asist
31 31300 12 Plan 12 $100 MM Asist
31 31300 13 Plan 13 $125 MM
31 31300 14 Plan 14 $150 MM
31 31300 15 Plan 15 $125 MM Asist
31 31300 16 Plan 16 $150 MM Asist "
personInfo:
personType (Required): Person type code.
govIssueIdentType (Required) :
Identification document type code
1 N.I.T.
2 Cédula de Ciudadanía
3 Cédula de Extranjería
4 Tarjeta de Identidad
5 Pasaporte
6 Registro Civil
7 Registro Médico
8 N.U.I.P.
9 C.I.I.U.
10 P.E.P
11 Provisional
12 Permiso Protección Temporal
identSerialNum (Required): identification number
lastName: last name
secondLastName: second surname
firstName: first name
middleName: middle name
thirdName: tercer Nombre
fullName: fullname
birthDt: date of birth DD-MM-YYYY
gender: gender
country: nationality
contactInfo: contact informaction
postAddr: array address
addr1: customer address
floor: floor number
stateProv: department code
cityId: city code
neighborhood: municipality code
postalCode: ZIP code
emailAddr: email addres
phoneNum: array phones
phoneType: type of phone
phoneAreaCode(Required): country code corresponding to the telephone number
phone(Required): Country code corresponding to the phone number
ccAcctRec: Credit card information in case the payment method is through it
code (Required): Bank code
1 Banco De Bogotá
2 Banco Popular
6 Banco Itau Corpbanca Colombia
7 Bancolombia S.A.
8 Scotiabank S.A.
9 Citibank Colombia
12 Banco Gnb Sudameris Colombia
13 Bbva Colombia <br>
19 Red Multibanca Colpatria S.A.
23 Banco De Occidente
32 Banco Caja Social
40 Banco Agrario De Colombia S.A.
51 Banco Davivienda S.A.
52 Banco Av Villas
53 Banco W S.A.
58 Banco Procredit
60 Banco Pichincha S.A.
61 Bancoomeva <br>
62 Banco Falabella S.A.
65 Banco Santander S.A.
507 Nequi <br>
558 BANCO CREDIFINANCIERA S.A.
cardType: Card type code :
1 Visa
2 Mastercard
3 Magna
4 Diners
5 American Express
acctId: Card number
expDt: Credit card expiration date
token: Token management
dayofDebitMonthly: Day for automatic debit
pmtMethod: Bank account information in case the payment method is through an account
depAcctId:
bankId: Bank code
1 Banco De Bogotá
2 Banco Popular
6 Banco Itau Corpbanca Colombia
7 Bancolombia S.A.
8 Scotiabank S.A.
9 Citibank Colombia
12 Banco Gnb Sudameris Colombia
13 Bbva Colombia <br>
19 Red Multibanca Colpatria S.A.
23 Banco De Occidente
32 Banco Caja Social
40 Banco Agrario De Colombia S.A.
51 Banco Davivienda S.A.
52 Banco Av Villas
53 Banco W S.A.
58 Banco Procredit
60 Banco Pichincha S.A.
61 Bancoomeva <br>
62 Banco Falabella S.A.
65 Banco Santander S.A.
507 Nequi <br>
558 BANCO CREDIFINANCIERA S.A.
acctType: Card type code:
1 Visa
2 Mastercard
3 Magna
4 Diners
5 American Express
acctId: Card number
dayofDebitMonthly: Credit card expiration date
pmtMethod: Bank direct debit type. Default value
insuranceInfo:
coverageInfo:
coverageId: Insurance policy code
role: Customer role, used in personal insurance lines
validityPeriod: Type of insurance duration, used in personal insurance lines
validityTime: Policy duration
amt: Coverage insured amount, used in personal insurance lines
rate: Rate (per mille) applied to the insured amount of the coverage to determine the annual premium to be charged for the coverage
ccAcctRec:
brand: Indicator of deductible or excess when coverage allows variation. Possible values according to table 64
rate: Percentage of deductible/excess to be applied when the coverage allows variation
amt: Fixed amount of deductible or excess when the coverage allows variation
insuranPremiumValue: Annual premium amount of the coverage
desc: Description of the coverage
additionalData:
coverageId: Insurance policy code
role: Customer role, used in personal insurance lines
validityPeriod: Type of insurance duration, used in personal insurance lines
validityTime: Policy duration
amt: Coverage insured amount, used in personal insurance lines
rate: Rate (per mille) applied to the insured amount of the coverage to determine the annual premium to be charged for the coverage
ccAcctRec:
brand: Indicator of deductible or excess when coverage allows variation. Possible values according to table 64
rate: Percentage of deductible/excess to be applied when the coverage allows variation
amt: Fixed amount of deductible or excess when the coverage allows variation
insuranPremiumValue: Annual premium amount of the coverage
desc: Description of the coverage
listValidation:
coverageId: Insurance policy code
role: Customer role, used in personal insurance lines
validityPeriod: Type of insurance duration, used in personal insurance lines
validityTime: Policy duration
amt: Coverage insured amount, used in personal insurance lines
rate: Rate (per mille) applied to the insured amount of the coverage to determine the annual premium to be charged for the coverage
ccAcctRec:
brand: Indicator of deductible or excess when coverage allows variation. Possible values according to table 64
rate: Percentage of deductible/excess to be applied when the coverage allows variation
amt: Fixed amount of deductible or excess when the coverage allows variation
insuranPremiumValue: Annual premium amount of the coverage
desc: Description of the coverage
identVerifyEntity: Basic capital code
idItem: Producer Code
rate: Insurable basic capital value
order: Percentage of basic capital to be insured
additionalData:
key: key for added value
value: added value
request :
{
"product": {
"productIdNumber": "24297",
"freq": "1"
},
"entprAgreement": {
"cityId": "421"
},
"pmtReferences": {
"pmtAuthId" : "1",
"pmtType": "1"
},
"coverageInfo":{
"coverageId": "1"
},
"personInfo": {
"personType": "4",
"govIssueIdentType": "12",
"identSerialNum": "55444111",
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"birthDt": "2022-12-11",
"gender": "1",
"country": "28",
"contactInfo" :{
"postAddr": [
{
"addr1": "Calle 4",
"floor": "414",
"stateProv": "35",
"cityId": "38041",
"neighborhood": "38041",
"postalCode": "04011031",
"phoneNum": [
{
"phoneType": "4",
"phoneAreaCode": "55",
"phone": "11999999999"
},
{
"phoneType": "2",
"phoneAreaCode": "55",
"phone": "11999999999"
}
]
}
]
},
"ccAcctRec": [
{
"code": "65",
"cardType": "3",
"acctId": "696369321563",
"expDt": "02/26",
"token": "6as5df-6d5f4ga-as5df-as5d4d4d",
"dayofDebitMonthly": 31,
"pmtMethod": "2"
}
],
"depAcctId": [
{
"bankId": "558",
"acctType": "2",
"acctId": "696369321563",
"dayofDebitMonthly": 3,
"pmtMethod": "2"
}
]
},
"insuranceInfo": {
"coverageInfo": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"additionalData": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"listValidation": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
]
},
"beneficiary": [
{
"personInfo": {
"personType": "4",
"govIssueIdentType": "12",
"identSerialNum": "55444111",
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"rate": "100",
"relationshipType": "5000",
"birthDt": "2022-12-11",
"gender": "1"
}
}
],
"identVerifyEntity": [
{
"idItem": 100391531 ,
"rate": 50,
"order": 1
},
{
"idItem": 100391531 ,
"rate": 50,
"order": 1
}
],
"additionalData": [
{
"key": "SecondName",
"value": "Pedro"
}
]
}Response information:
responseDetail:
errorCode: Contains information of Error code
errorDesc: Contains information of Error description
startDt: Contains information of transaction timestamp
insuranceInfo{}:
cSpRefId: Origen del cobro
trnRquId: Numero de cobro
operationType: billType
effDt: fecha ini
endDt: fecha fin
insuranPremiumValue: Suma Asegurada de la cobertura
fee:
amt: Impuestos
rate: Comision
policyId: Numero de poliza
certCode: Certificado
forExRateInqRq:
depAcctId: Numero de cotizacion
> Example of Body to Response Successfull.
{
"insuranceInfo":{
"cSpRefId": "Emisión",
"trnRquId":"37330",
"operationType":"Cobro" ,
"effDt":"2022-12-11",
"endDt":"2022-12-11",
"insuranPremiumValue":90998.136986,
"fee":{
"amt": 90998.136986
},
"rate":90998.136986,
"policyId": "960",
"certCode": "21344545",
"forExRateInqRq": {
"depAcctId":"960"
}
}
}
- [Life] certificate:
Description: This service allows you to create a Life certificate pdf
Path: [ Method: POST ]
/policy-management/v1/life/certificate:
Request [] information:
product:
productIdNumber(Required) : Contains information of product identifier:
24297 = Tu Ingreso Protegido
27298 = Tu Ahorro Amigo
3130 = AP Individual Banco Caja Socia
insuranceInfo:
policyId (Required) :Number identifying the Policy/Quotation/Application
effDt: Effective Date of The Policy/Certificate Formato string AAAA-MM-DD.
certCode: Number identifying the certificate.
request :
{
"product": {
"productIdnumber": "31300"
},
"insuranceInfo": {
"policyId": 45878,
"effDt": "2023-08-24",
"certCode": 123444
}
}Response information:
responseDetail:
errorCode: Contains information of Error code
errorDesc: Contains information of Error description
insuranceInfo{}:
binData: Certificate document in base64
> Example of Body to Response Successfull.
{
{
"responseDetail": {
"errorCode": "",
"errorDesc": ""
},
"insuranceInfo": {
"binData":"JVBERi0xLjMNCiX/gfCwDQoxIDAgb2JqIA0KPDwgL1R5cGUgL0NhdGFsb2cNCi9QYWdlcyAyIDAgUg0KPj4NCmVuZG9iag0KMiAwIG9iaiAN
Cjw8IC9UeXBlIC9QYWdlcw0KL0NvdW50IDENCi9LaWRzIFs"
}
}
- Simulation [General] :
Path: [POST]/policy-management/v1/general/simulation
Description: Post xAPI insurance create simulation general for Life ,card-protection ,home/fire Insurance, for consult products :
Product Codes table :
| product.productIdNumber (ProductCode) | Description(Descripcion) | productIdent |
|---|---|---|
| 24297 | Tu Ingreso Protegido | productIdent=1 |
| 24298 | Tu Ahorro Amigo (Protección de ahorro) | productIdent=1 |
| 31300 | Accidentes Personales, Individual Banco Caja Social | productIdent=1 |
| 34299 | Vida protegida (Vida con enfermedades graves) | productIdent=1 |
| 69308 | Tarjeta protegida Individual | productIdent=2 |
| 67307 | Hogar Residencial | productIdent=3 |
** Mapping Request/Response detailed ,located in [POST] /policy-management/v1/general/simulation :
> Request body example (for productIdent=1 ) :
{
"productIdent" : "1",
"product": {
"productIdNumber": "31300",
"freq":"1"
},
"insuranceInfo": {
"channel": "101",
"personName": {
"birthDt": "30-12-1993"
}
}
}> Request body example (for productIdent=2 ) :
{
"productIdent" : "2",
"product": {
"productIdNumber": "69308",
"freq":"1"
},
"insuranceInfo": {
"channel": "101",
"personName": {
"birthDt": "30-12-1990"
}
},
"additionalData": [
{
"key": "SecondName",
"value": "Pedro"
}
]
}> Request body example (for productIdent=3 ) :
{
"productIdent": "3",
"product": {
"productIdNumber": "307",
"freq": "1"
},
"insuranceInfo": {
"channel": "101",
"capitalization": [
{
"capitalizationAcctId": "2",
"capitalizationAcctAm": "2",
"rate": 100,
"amt": 195000000
}
],
"riskInfo": {
"postAddr": [
{
"addr1": "AVENIDA BRASIL",
"floor": "1",
"stateProv": "52",
"cityId": "52835",
"neighborhood": "5438",
"postalCode": "01101"
}
],
"additionalData": {
"idItem": "1",
"areaType": "1",
"socialClass": "1",
"useType": "1",
"type": "2",
"year": "1993",
"floor": "1",
"desc": "Orange House",
"housingType": "3"
}
}
}
}
> Example of Body to Response Successfull.
{
"responseDetail": {
"errorCode": "",
"errorDesc": "",
"startDt": "2023-07-19T10:28:27.0131805-05:00"
},
"insuranceInfo": [
{
"product": {
"productLine": 31,
"productClass": 31300,
"idItem": 1,
"desc": "Plan 1 5 MM",
"fee": {
"totalInsurableValue": 200
},
"freq": 1
},
"coverageInfo": [
{
"coverageId": 1,
"desc": "Muerte Accidental",
"amt": 5000000.0,
"fee": {
"insuranPremiumValue": 0.0
},
"insuranPremiumValue": 59880.0
},
{
"coverageId": 2,
"desc": "Incapacidad Total y Permanente Accidental",
"amt": 0.0,
"fee": {
"insuranPremiumValue": 0.0
},
"insuranPremiumValue": 0.0
}
]
},
{
"product": {
"productLine": 31,
"productClass": 31300,
"idItem": 2,
"desc": "Plan 2 10 MM",
"fee": {
"totalInsurableValue": 300
},
"freq": 2
},
"coverageInfo": [
{
"coverageId": 1,
"desc": "Muerte Accidental",
"amt": 10000000.0,
"fee": {
"insuranPremiumValue": 0.0
},
"insuranPremiumValue": 83880.0
},
{
"coverageId": 2,
"desc": "Incapacidad Total y Permanente Accidental",
"amt": 0.0,
"fee": {
"insuranPremiumValue": 0.0
},
"insuranPremiumValue": 0.0
}
]
}
]
}
####
> Response Error.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ERR400"
},
"responseDetail": {
"errorCode": 400,
"errorDesc": "Payload not found",
"errorType": "Bad Request"
}
}
- Quote [General] :
Path: [POST]/policy-management/v1/general/quote
Description: This service allows you to create a Post xAPI insurance create quote general for Life ,card-protection ,home/fire Insurance.General Quote(xAPI) , for consult products :
Product Codes table :
| product.productIdNumber (ProductCode) | Description(Descripcion) | productIdent |
|---|---|---|
| 24297 | Tu Ingreso Protegido | productIdent=1 |
| 24298 | Tu Ahorro Amigo (Protección de ahorro) | productIdent=1 |
| 31300 | Accidentes Personales, Individual Banco Caja Social | productIdent=1 |
| 34299 | Vida protegida (Vida con enfermedades graves) | productIdent=1 |
| 69308 | Tarjeta protegida Individual | productIdent=2 |
| 67307 | Hogar Residencial | productIdent=3 |
** Mapping Request/Response detailed ,located in [POST] /policy-management/v1/general/quote:
> Request body example (for productIdent=1 ) :
{
"productIdent": "1",
"product": {
"productIdNumber": 34299,
"freq": 1
},
"entprAgreement": {
"cityId": "2013"
},
"coverageInfo": {
"coverageId": 1
},
"insuranceInfo": {
"personType": 1,
"channel": 101,
"govIssueIdent": {
"govIssueIdentType": 2,
"identSerialNum": "10229896891"
},
"personName": {
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"birthDt": "19-03-1970",
"gender": 1,
"country": "0",
"maritalStatus": "1"
},
"contactInfo": [
{
"emailAddr": "TESTE@GMAIL.COM",
"phoneNum": [
{
"phoneType": 4,
"phoneAreaCode": 55,
"phone": "11999999999"
}
]
}
],
"coverageInfo": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"additionalData": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"listValidation": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
]
},
"identVerifyEntity": [
{
"idItem": 100391531,
"rate": 50,
"order": 1
}
],
"additionalData": [
{
"key": "SecondName",
"value": "Pedro"
}
]
}
> Request body example (for productIdent=2 ) :
{
"productIdent": "2",
"product": {
"productIdNumber": 31300,
"freq": 1,
"productLine": 10
},
"entprAgreement": {
"cityId": "6005"
},
"coverageInfo": {
"coverageId": 1
},
"insuranceInfo": {
"personType": 1,
"channel": 101,
"govIssueIdent": {
"govIssueIdentType": 3,
"identSerialNum": "300541"
},
"personName": {
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"birthDt": "19-03-1970",
"gender": 1,
"country": "0",
"maritalStatus": "1"
},
"contactInfo": [
{
"emailAddr": "TESTE@GMAIL.COM",
"phoneNum": [
{
"phoneType": 4,
"phoneAreaCode": 55,
"phone": "11999999999"
}
]
}
],
"coverageInfo": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"additionalData": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"listValidation": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
]
},
"identVerifyEntity": [
{
"idItem": 100391531,
"rate": 50,
"order": 1
}
],
"additionalData": [
{
"key": "SecondName",
"value": "Pedro"
}
]
}###
> Request body example (for productIdent=3 ) :
{
"productIdent": "3",
"product": {
"productIdNumber": 307,
"freq": 1
},
"entprAgreement": {
"cityId": "1"
},
"coverageInfo": {
"coverageId": 1
},
"insuranceInfo": {
"channel": 101,
"capitalization": [
{
"capitalizationAcctId": "2",
"capitalizationAcctAm": "2",
"rate": 100,
"amt": 195000000
}
],
"riskInfo": {
"postAddr": [
{
"addr1": "AVENIDA BRASIL",
"floor": "1",
"stateProv": "52",
"cityId": "52835",
"neighborhood": "5438",
"postalCode": "01101"
}
],
"additionalData": {
"idItem": "1",
"areaType": "1",
"socialClass": "1",
"useType": "1",
"type": "2",
"year": "1993",
"floor": "1",
"desc": "Orange House",
"housingType": "3"
}
},
"personType": 1,
"govIssueIdent": {
"govIssueIdentType": 3,
"identSerialNum": "300541"
},
"personName": {
"issDt": "2022-12-11",
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"birthDt": "1970-03-19",
"gender": 1,
"country": "0",
"maritalStatus": "1"
},
"stipend":{
"contractType": 12,
"rate": 5,
"amt": 0
},
"contactInfo": [
{
"emailAddr": "TESTE@GMAIL.COM",
"phoneNum": [
{
"phoneType": 4,
"phoneAreaCode": 55,
"phone": "11999999999"
}
]
}
],
"coverageInfo": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"additionalData": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"listValidation": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
]
},
"identVerifyEntity": [
{
"idItem": 100391531,
"rate": 50,
"order": 1
}
],
"additionalData": [
{
"key": "SecondName",
"value": "Pedro"
}
]
}
###
> Example of Body to Response Successfull.
{
"pmtReferences": {
"pmtAuthId": 1221
},
"responseDetail": {
"errorCode": "",
"errorDesc": "",
"startDt": "2023-06-06T16:27:14.2168106-05:00"
},
"insuranceInfo": {
"coverageInfo": [
{
"coverageId": 1,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX",
"additionalData": {
"type": 1,
"amt": 12683
}
}
]
},
"invoicePremium": {
"fee": {
"totalInsurableValue": 27775,
"amt": 2409
},
"billId": 1111,
"insuranPremiumValue": 25366
},
"product": {
"idItem": 1,
"desc": "XXXXXXXXXXXXX",
"freq": 1
}
}
####
> Response Error.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ERR400"
},
"responseDetail": {
"errorCode": 400,
"errorDesc": "Payload not found",
"errorType": "Bad Request"
}
}
- Issuing [General] :
Path: [POST]/policy-management/v1/general/issuing
Description: Post xAPI insurance create issuing general for Life ,card-protection ,home/fire Insurance , for consult products :
Product Codes table :
| product.productIdNumber (ProductCode) | Description(Descripcion) | productIdent |
|---|---|---|
| 24297 | Tu Ingreso Protegido | productIdent=1 |
| 24298 | Tu Ahorro Amigo (Protección de ahorro) | productIdent=1 |
| 31300 | Accidentes Personales, Individual Banco Caja Social | productIdent=1 |
| 34299 | Vida protegida (Vida con enfermedades graves) | productIdent=1 |
| 69308 | Tarjeta protegida Individual | productIdent=2 |
| 67307 | Hogar Residencial | productIdent=3 |
** Mapping Request/Response detailed ,located in [POST] /policy-management/v1/general/issuing:
###
> Request body example (for productIdent=1 ) :
{
"productIdent": "1",
"product": {
"productIdNumber": "31300",
"freq": "5",
"channel": 101
},
"entprAgreement": {
"cityId": "106"
},
"pmtReferences": {
"pmtAuthId": "2507",
"pmtType": "2"
},
"coverageInfo": {
"coverageId": "8"
},
"personInfo": {
"personType": "1",
"govIssueIdentType": "2",
"identSerialNum": "44458129653",
"lastName": "SUAREZ",
"firstName": "ANGELICA",
"fullName": "ANGELICA SUAREZ",
"birthDt": "1979-03-21",
"gender": "2",
"maritalStatus": "1",
"country": "0",
"contactInfo": {
"postAddr": [
{
"addr1": "CL 78 45 12",
"cityId": "11001",
"emailAddr": "r0s5s0u5@bancocajasocial.com",
"phoneNum": [
{
"phoneType": "6",
"phoneAreaCode": "57",
"phone": "3002222222"
}
]
}
]
},
"ccAcctRec": [
{
"code": "32",
"cardType": "1",
"acctId": "4704371043791074",
"expDt": "12/24"
}
]
},
"beneficiary": [
{
"personInfo": {
"personType": "1",
"govIssueIdentType": "2",
"identSerialNum": "52433530",
"lastName": "SUAREZ",
"firstName": "FERNANDO",
"fullName": "FERNANDO SUAREZ",
"rate": "50",
"relationshipType": "3"
}
},
{
"personInfo": {
"personType": "1",
"govIssueIdentType": "4",
"identSerialNum": "456456",
"lastName": "SUAREZ",
"firstName": "FERNANDO",
"fullName": "FERNANDO SUAREZ",
"rate": "50",
"relationshipType": "3"
}
}
],
"additionalData": [
{
"key": "AUDH1V7G",
"value": "Harol Villareal"
}
]
}
> Request body example (for productIdent=2 ) :
{
"productIdent": "2",
"product": {
"productIdNumber": "69308",
"freq": "1",
"channel": 101
},
"entprAgreement": {
"cityId": "421"
},
"pmtReferences": {
"pmtAuthId": "1",
"pmtType": "1"
},
"coverageInfo": {
"coverageId": "1"
},
"personInfo": {
"personType": "4",
"govIssueIdentType": "12",
"identSerialNum": "55444111",
"issDt": "2022-12-11",
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"birthDt": "2022-12-11",
"gender": "1",
"country": "0",
"maritalStatus": "1",
"contactInfo": {
"postAddr": [
{
"addr1": "Calle 4",
"floor": "414",
"stateProv": "35",
"cityId": "38041",
"neighborhood": "38041",
"postalCode": "04011031",
"emailAddr": "TESTE@GMAIL.COM",
"phoneNum": [
{
"phoneType": "4",
"phoneAreaCode": "55",
"phone": "11999999999"
},
{
"phoneType": "2",
"phoneAreaCode": "55",
"phone": "11999999999"
}
]
}
]
},
"ccAcctRec": [
{
"code": "65",
"cardType": "3",
"acctId": "696369321563",
"expDt": "02/26",
"token": "6as5df-6d5f4ga-as5df-as5d4d4d",
"dayofDebitMonthly": 31,
"pmtMethod": "2"
}
],
"depAcctId": [
{
"bankId": "558",
"acctType": "2",
"acctId": "696369321563",
"dayofDebitMonthly": 3,
"pmtMethod": "2"
}
]
},
"insuranceInfo": {
"coverageInfo": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"additionalData": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"listValidation": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
]
},
"beneficiary": [
{
"personInfo": {
"personType": "4",
"govIssueIdentType": "12",
"identSerialNum": "55444111",
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"rate": "100",
"relationshipType": "5000",
"birthDt": "2022-12-11",
"gender": "1"
}
}
],
"identVerifyEntity": [
{
"idItem": 100391531,
"rate": 50,
"order": 1
},
{
"idItem": 100391531,
"rate": 50,
"order": 1
}
],
"additionalData": [
{
"key": "SecondName",
"value": "Pedro"
}
]
}
###
> Request body example (for productIdent=3) :
{
"productIdent": "3",
"product": {
"productIdNumber": "307",
"freq": "1",
"channel": 101
},
"entprAgreement": {
"cityId": "421"
},
"pmtReferences": {
"pmtAuthId": "1",
"pmtType": "1"
},
"coverageInfo": {
"coverageId": "1"
},
"insuranceInfo": {
"capitalization": [
{
"capitalizationAcctId": "2",
"capitalizationAcctAm": "2",
"rate": 100,
"amt": 195000000
}
],
"riskInfo": {
"postAddr": [
{
"addr1": "AVENIDA BRASIL",
"floor": "1",
"stateProv": "52",
"cityId": "52835",
"neighborhood": "5438",
"postalCode": "01101"
}
],
"additionalData": {
"idItem": "1",
"areaType": "1",
"socialClass": "1",
"useType": "1",
"type": "2",
"year": "1993",
"floor": "1",
"desc": "Orange House",
"housingType": "3"
}
},
"coverageInfo": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"additionalData": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
],
"listValidation": [
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
},
{
"coverageId": 1,
"role": 2,
"validityPeriod": 100,
"validityTime": 100,
"amt": 501000,
"rate": 2.9925,
"ccAcctRec": {
"brand": 3,
"rate": 5,
"amt": 25000
},
"insuranPremiumValue": 152200,
"desc": "XXXXXXXXXXXXX"
}
]
},
"personInfo": {
"personType": "4",
"govIssueIdentType": "12",
"identSerialNum": "55444111",
"issDt": "2022-12-11",
"lastName": "XXXXXXX",
"secondLastName": "XXXXXXX",
"firstName": "XXXXXXXXXX",
"middleName": "XXXXXXXXXX",
"thirdName": "XXXXXXXXXX",
"fullName": "XXXXXXXXXX",
"birthDt": "2022-12-11",
"gender": "1",
"country": "28",
"maritalStatus": "1",
"contactInfo": {
"postAddr": [
{
"addr1": "Calle 4",
"floor": "414",
"stateProv": "35",
"cityId": "38041",
"neighborhood": "38041",
"postalCode": "04011031",
"emailAddr": "TESTE@GMAIL.COM",
"phoneNum": [
{
"phoneType": "4",
"phoneAreaCode": "55",
"phone": "11999999999"
},
{
"phoneType": "2",
"phoneAreaCode": "55",
"phone": "11999999999"
}
]
}
]
},
"ccAcctRec": [
{
"code": "65",
"cardType": "3",
"acctId": "696369321563",
"expDt": "02/26",
"token": "6as5df-6d5f4ga-as5df-as5d4d4d",
"dayofDebitMonthly": 31,
"pmtMethod": "2"
}
],
"depAcctId": [
{
"bankId": "558",
"acctType": "2",
"acctId": "696369321563",
"dayofDebitMonthly": 3,
"pmtMethod": "2"
}
]
},
"identVerifyEntity": [
{
"idItem": 100391531,
"rate": 50,
"order": 1
},
{
"idItem": 100391531,
"rate": 50,
"order": 1
}
],
"additionalData": [
{
"key": "SecondName",
"value": "Pedro"
}
]
}
> Example of Body to Response Successfull.
{
"insuranceInfo": {
"cSpRefId": "Emisión",
"trnRquId": "37330",
"operationType": "Cobro",
"effDt": "2022-12-11",
"endDt": "2022-12-11",
"insuranPremiumValue": 90998.136986,
"fee": {
"amt": 90998.136986
},
"rate": 90998.136986,
"policyId": "960",
"certCode": "21344545",
"forExRateInqRq": {
"depAcctId": "960"
}
}
}####
> Response Error.
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ERR400"
},
"responseDetail": {
"errorCode": 400,
"errorDesc": "Payload not found",
"errorType": "Bad Request"
}
}
###
- Customer payee :
**Description: insert costumer payee digital banking
Path:
POST /policy-management/v1/costumer-payee
Request information:
Request
govIssueIdent:
govIssueIdentType: Type of identification issued by the country's government ...
POSIBLE VALUES
CC: Citizenship Card
CE: Immigration Card
LC: Driving License
NI: NIT
OT: Other
PA: Passport
RC: Civil Registry
IT: Identity Card
identSerialNum: Identification number
beneficiary:
personName:
firstName: First name
middleName: Second name
lastName: First lastname
secondLastName: Second lastname
personInfo:
country: natiolality
emailAddr: email address
postAddr:
country: country code using ISO 3166
notification:
address: address to recive notification,
postalCode: postal code
govIssueIdent:
govIssueIdentType: Type of identification issued by the country's government ...
POSIBLE VALUES
CC: Citizenship Card
CE: Immigration Card
LC: Driving License
NI: NIT
OT: Other
PA: Passport
RC: Civil Registry
IT: Identity Card
identSerialNum: Identification number
countryName: Country name of the identification
relationshipType: Type of relationship among beneficiary and customer
submitOffice:
branchId: Branch indentifier number
adviserId: Advisor identifier number
Request example:
{
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "3056441"
},
"beneficiary": {
"personName": {
"firstName": "LUIS",
"middleName": "",
"lastName": "GONZALEZ",
"secondLastName": ""
},
"personInfo": {
"country": "169",
"emailAddr": "smora@bancocajasocial.com"
},
"postAddr": {
"country":"169"
},
"notification": {
"address": "KR 80",
"postalCode": "432566"
},
"govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "3056441",
"countryName": "COLOMBIA"
},
"relationshipType": "60"
},
"submitOffice": {
"branchId": "1102",
"adviserId": "4342"
}
}Response information:
ResponseDatail
responseType: Estatus of the operation
Example of Body to Response Successfull.:
{
"responseType": {
"value": "OK"
}
}Response error:
Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
"responseType": {
"value": "ER"
},
"responseDetail": {
"errorCode": "OSB-38235",
"errorDesc": "Variable targeted for validate is not a XML",
"errorType": "EXP"
}
}