bcs-documents-management-api-services

API INFORMATION

Title: documents-management-api-service

Version: 1.0.26

Protocols: HTTPS

URI Sandbox: https://documents-management-api-services-dev.us-e1.cloudhub.io/api/documentsManagement/v1

URI QA: https://documents-management-api-services-qa.us-e1.cloudhub.io/api/documentsManagement/v1

URILive: https://documents-management-api-services-prod.us-e1.cloudhub.io/api/documentsManagement/v1

DOWLOAD RAML

DESCRIPTION

The API offers consumers their flow of creation of physical and digitized documents, storage, management and custody, allows the following operations:

Summary

-Create Digitized Documents

Path:

/documentsManagement/v1/Accounts:

Headers

Response information:

responseType: Used to return the response

file: It is used to display the information of the files

-Spinner Creation

Path:

/documentsManagement/v1/Check:

Headers

Response information:

responseType: Used to return the response

govIssueIdent: Used to user identification number and User ID Type

catalogueInfo: ADD_ME

listProducts: Contains the list of products

-Create Promissory Note

Path:

/documentsManagement/v1/Note:

Headers

Response information:

responseType: Used to return the response

govIssueIdent: Used to user identification number and User ID Type

catalogueInfo: ADD_ME

listProducts: Contains the list of products

-Create Digital Signature

Path:

/documentsManagement/v1/Signature:

Headers

Response information:

responseType: Used to return the response

additionalStatus: Successful Response

-Store Digitized Documents

Path:

/documentWCCManagement/v1/Accounts:

Headers

Response information:

responseType: Used to return the response

file: It is used to display the information of the files

-Create Certificate

Allows the creation of account certificate

Path:

POST

/certificates-management/v1/customer

Headers

Headers Invoker

Headers Security

Body:

govIssueIdent: Identification given by the local government (Required)

govIssueIdentType: Type of customer identification. (CC, CE, LC, NI, OT, PA or RC)
identSerialNum: Number customer Identification

selRangeDt: Contains the search date (Required)

startDt: Month and Year search period

depAcctStmtRec: Contains the products(Required)

decAcctId: Product Number

statement: customer information (Required)

statementType: Certificate type
flagAmt: indicates if the balance should come

personName: Contains the search date (Required)

firstName: Customer's First Name
fullName: Full name

language: language information (Required)

languageCode: Language in which it is generated

product: product information (Required)

productId: contains the product id

totalCurAmt: contains information loan value (Required)

amt: home loan value

Example of Body

{
  "govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "63343922"
},
  "selRangeDt": {
"startDt": "2022-05-17"
    },
  "depAcctStmtRec": {
    "decAcctId": {
        "acctId": "24567890123",
        "productName": "24567890123"
    }
  },
  "statement": {
    "statementType": "C2",
    "flagAmt": "true"
  },
  "personName": {
    "firstName": "Carlos",
    "fullName": "GIRALDO RIPOLL ESTEBAN RAUL"
  },
  "language": {
    "languageCode": "ES"
    },
    "product": {
      "productId": {
          "ledgerCode": "24",
          "subLegerCode": "24",
          "groupCode": "00"
        }
    },
  "totalCurAmt": {
    "amt": "7500999"
    }
}

Response information:

responseType: Used to return the response

file: It is used to display the information of the files

Example of Body to Response Successfull

{
  "file": {
    "binData": "JVBERi0xLjYNCjUgMCBvYmoNCjw8DQovVHl"
  }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "00001",
        "errorDesc": "No hay conexión a la base de datos.",
        "errorType": "DB"
    }
}

> Diagram of sequence.

-Statement Generated

This operation is used to query information related to : Statements Generated ..

GET

Request example 1:

[List of the last extract generated for each of the client's products that are in the repository.]

/documentsManagement/v1/statement/{identSerialNum}?operation=statementGenerated&govIssueIdentType=CC

Request example 2 :

[List of all extracts of all products (indicated period* or 12 months** ) :operation, identSerialNum, govIssueIdentType,operation, acctId=ALL, month,year]

* /documents-management/statement/{identserialnum}?** acctId=ALL&month=6&year=2022&operation=statementGenerated&govIssueIdentType=CC

** /documents-management/statement/{identserialnum}?acctId=ALL&month=0&year=0&operation=statementGenerated&govIssueIdentType=CC

Request example 3 :

[ List the extracts for the selected product and indicated period :operation, identSerialNum, govIssueIdentType, acctId, month,year]

/documents-management/statement/{identserialnum}?acctId=25026685533&month=6&year=2022&operation=statementGenerated&govIssueIdentType=CC

Request example 4 :

[ List the extracts for this product (12 months) :operation, identSerialNum, govIssueIdentType,month=0, year=0, acctId]

/documents-management/statement/{identserialnum}?acctId=24626684323&month=0&year=0&operation=statementGenerated&govIssueIdentType=CC

Request example 5 :

[ List a single record with the name of the extract generated for that product and the indicated period :operation, identSerialNum, govIssueIdentType,month, year, acctId]

/documents-management/statement/{identserialnum}?acctId=24626684323&month=6&year=2022&operation=statementGenerated&govIssueIdentType=CC

The service has the following logic:

-URI parameters

identserialnum: Contains information related to user identification number . (Required ej, 19444454 )

-Query parameters

acctId: Contains information related to product number. (Optional word ('ALL') to consult all the extracts of the products for the selected period)

month: Consultation month. (Optional )

year: Consultation year. (Optional , Internal default value : current year ej. 2022 )

operation: Consultation operation: (Required)

- statementGenerated

govIssueIdentType: Type of customer identification .(Required)

- CC (Citizenship Card )
- CE (Immigration ID )
- PA ( Passport )
- TI (Identity card)
- NI (NIT)
- PE (Special Stay Permit (for Venezuelans))

Headers

Headers Invoker

Headers Security

Response information:

The objects of the operation are described below:

responseType: Used to return the response type.

stmtRec: Contains information related to statement generated.

 externalFileId: Contains information of file Id.
 fileId: Contains information of file Id.
 fileName: Contains information related  to file name.
 month: Contains information related  to month .
 year: Contains information related  to year .
 acctId: Contains information related  to product number.
 path: Contains information related  to path.

> Response 200.

  {
    "responseType": {
        "value": "OK"
    },
    "stmtRec": [
        {
            "externalFileId": "A1CC000002100289041520220100",
            "fileId": "A1CC000002100289041520220100",
            "fileName": "",
            "month": "03",
            "year": "2022",
            "acctId": "21002890415",
            "path": ""
        },
        {
            "externalFileId": "A1SU000002402669071020220600",
            "fileId": "A1SU000002402669071020220600",
            "fileName": "",
            "month": "06",
            "year": "2022",
            "acctId": "24026690780",
            "path": ""
        },
        {
            "externalFileId": "A1SU000002402169157420220600",
            "fileId": "A1SU000002402169157420220600",
            "fileName": "",
            "month": "06",
            "year": "2022",
            "acctId": "24026691574",
            "path": ""
        },
        {
            "externalFileId": "A1SU000001402669577820220600",
            "fileId": "A1SU000001402669577820220600",
            "fileName": "",
            "month": "06",
            "year": "2022",
            "acctId": "24026695778",
            "path": ""
        },
        {
            "externalFileId": "A1SU000001402669577820220600",
            "fileId": "A1SU000002412669716120220600",
            "fileName": "",
            "month": "06",
            "year": "2022",
            "acctId": "24026697161",
            "path": ""
        },
        {
            "externalFileId": "A1SU000001402669577820220600",
            "fileId": "A1SU000002412669851320220600",
            "fileName": "",
            "month": "06",
            "year": "2022",
            "acctId": "24026698513",
            "path": ""
        },
        {
            "externalFileId": "A1SU000002412675936220220600",
            "fileId": "A1SU000002412675936220220600",
            "fileName": "",
            "month": "06",
            "year": "2022",
            "acctId": "24026759362",
            "path": ""
        }
    ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "000001",
        "errorDesc": "Invalid identification type",
        "errorType": "CED"
    }
}

> Diagram of sequence.

-Statement Detail

This operation is used to query information related to : Statements detail .

Request example:

GET

Request example 1 :[returns the binary corresponding to the extract file - base 64 with filter acctId]

/documents-management/v1/statement/{identserialnum}?acctId=24026685593&month=6&year=2022&operation=statementDetail&govIssueIdentType=CC

Request example 2 : [returns the binary corresponding to the extract file - base 64 with filter fileId]

/documents-management/v1/statement/{identserialnum}?operation=statementDetail&govIssueIdentType=CC&fileId=A1LP000013320005595220220800

Request example 3 : [returns the binary corresponding to the extract file - base 64 with filter fileId]

/documents-management/v1/statement/{identserialnum}?operation=statementDetail&govIssueIdentType=CC&externalFileId=A1LP000013320005595220220800

-URI parameters

identserialnum: Contains information related to user identification number (Required ej, 19444454 )

-Query parameters

acctId: Contains information related to product number. (Optional )

month: Consultation month. (Optional )

year: Consultation year. (Optional ej. 2022 )

fileId: File Id for consult , only for statementDetail. (Optional ej. A1SU000002400488957320220400 )

externalFileId: File Id for consult , only for statementDetail. (Optional ej. A1SU000002400488957320220400 )

operation: Consultation operation: (Required)

- statementDetail

govIssueIdentType: Type of customer identification .(Required)

- CC (Citizenship Card )
- CE (Immigration ID )
- PA ( Passport )
- TI (Identity card)
- NI (NIT)
- PE (Special Stay Permit (for Venezuelans))

Headers

Headers Invoker

Headers Security

Response information:

The objects of the operation are described below:

responseType: Used to return the response type.

stmtRec: Contains information related to statement detail.

externalFileId: Contains information of file Id.
fileId: Contains information of file Id.
 fileName: Contains information related  to file name.
 month: Contains information related  to month .
 year: Contains information related  to year .
 acctId: Contains information related  to product number.
 path: Contains information related  to path.
 binData: Contains information related the binary corresponding to the extract file base 64.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "stmtRec": [
    {
      "externalFileId": "B1CC000002100238710420220300",
      "fileId": "B1CC000002100238710420220300",
      "fileName": "",
      "month": "0",
      "year": "0",
      "acctId": "",
      "path": ",
      "binData": "gUgovaVNRUEY0ZWU5OWU0NiAxMCAwIFIKPj4KL0V4dEdTdGF0ZSA8PAovaVNRUEdTYjlkMDgyYTEgMTEgMCBSCj4+Ci9YT2JqZWN0IDw8Ci9pU1FQSW02ZDQ4OGFkNyAxMiAwIFIKL2lTUVBJbTQ4MGFiMGMwIDEzIDAgUgovaVNRUEltOWNhNTU5ZjIgMTQgMCBSCi9pU1FQSW1kZjY0NzZiOCAxNSAwIFIKL2lTUVBJbTNkOTA3OWY5IDE2IDAgUgo+Pgo+PgovQ29udGVudHMgWyA1IDAgUiBdCi9NZWRpYUJveCBbIDAgMCA2MTIgNzkyIF0KL0Nyb3BCb3ggWyAwIDAgNjEyIDc5MiBdCj4+CmVuZG9iagozIDAgb2JqCjw8Ci9UeXBlIC9DYXRhbG9nCi9QYWdlcyAxIDAgUgovVmlld2VyUHJlZmVyZW5jZXMgPDwKL0NlbnRlcldpbmRvdyB0cnVlCi9EaXNwbGF5RG9jVG"
    }
  ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "000004",
        "errorDesc": "Invalid Product Number",
        "errorType": "CED"
    }
}

> Diagram of sequence.

-Statement Products

This operation is used to query information related to : Statements Products ..

GET

Request example 1:

[Call the service to send a message with the extracts generated for the selected product that are in the repository (Last Month) providing email address.]

/documents-management/v1/statement/{identSerialNum}?operation=statementProducts&govIssueIdentType=CC&acctId=12345678&emailAddress=customer@mail.com

[Call the service to send a message with the extracts generated for the selected product that are in the repository (Last Month) providing cell phone.]

/documents-management/v1/statement/{identSerialNum}?operation=statementProducts&govIssueIdentType=CC&acctId=12345678&cellPhone=2233445566

###

-URI parameters

identserialnum: Contains information related to user identification number . (Required ej, 19444454 )

-Query parameters

acctId: Contains information related to product number. (Optional word ('ALL') to consult all the extracts of the products for the selected period)

operation: Consultation operation: (Required)

- statementProducts

govIssueIdentType: Type of customer identification .(Required)

- CC (Citizenship Card )
- CE (Immigration ID )
- PA ( Passport )
- TI (Identity card)
- NI (NIT)
- PE (Special Stay Permit (for Venezuelans))

emailAddress: Customer email address .(Required)

cellPhone: Customer cell phone number, (Required when no email address is provided)

Headers

Headers Invoker

Headers Security

Response information:

The objects of the operation are described below:

responseType: Used to return the response type.

stmtRec: Contains information related to statement generated.

 desc: Contains response message.

> Response 200.

  {
    "responseType": {
        "value": "OK"
    },
    "stmtRec":{
      "desc": "Statements were successfully processed"
    }
 }

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the followin structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "000001",
        "errorDesc": "Invalid identification type",
        "errorType": "CED"
    }
}

> Diagram of sequence.

-Fiduciary Assignment

This operation is used to: Generate Acceptance Letter

POST

Request example:

/certificates-management/v1/fiduciary-assignment

Body

personName.fullName :Clients full name

contactInfo.postAddr.addr1 :Clients address

contactInfo.postAddr.city :City

contactInfo.phoneNum :Phone number

contactInfo.fax :Fax number

contactInfo.emailAddr :Email address

invoiceInfo.processDate :Date in which the process is being made

invoiceInfo.upDt :Last recorded datetime of system entry

invoiceInfo.effDt :System current datetime

trn.trnRqUID :Transaction number

trn.xferId :Investments fonds number

trn.depAcctId.acctId :Transaction associated account

trn.personInfo[n].govIssueIdent.govIssueIdentType :Investor identification type

trn.personInfo[n].govIssueIdent.identSerialNum :Investor identification number

trn.personInfo[n].personName.fullName :Investor full name

submitOffice.networkOwner :Constant "Banco Caja Social"

submitOffice.branchName :Constant "Banco Caja Social INTERNET"

questionList[3].question.answer.value :Check (S/N) for Acceptance Letter Easy Rent

Headers

Headers Invoker

Headers Security

Response information:

This operation is used togenerated the acceptance letter for “Renta Facil”:

responseType: Used to return the response type.

file. binData :Generated document coded in Base64

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "file":{
      "binData": "gUgovaVNRUEY0ZWU5OWU0NiAxMCAwIFIKPj4KL0V4dEdTdGF0ZSA8PAovaVNRUEdTYjlkMDgyYTEgMTEgMCBSCj4+Ci9YT2JqZWN0IDw8Ci9pU1FQSW02ZDQ4OGFkNyAxMiAwIFIKL2lTUVBJbTQ4MGFiMGMwIDEzIDAgUgovaVNRUEltOWNhNTU5ZjIgMTQgMCBSCi9pU1FQSW1kZjY0NzZiOCAxNSAwIFIKL2lTUVBJbTNkOTA3OWY5IDE2IDAgUgo+Pgo+PgovQ29udGVudHMgWyA1IDAgUiBdCi9NZWRpYUJveCBbIDAgMCA2MTIgNzkyIF0KL0Nyb3BCb3ggWyAwIDAgNjEyIDc5MiBdCj4+CmVuZG9iagozIDAgb2JqCjw8Ci9UeXBlIC9DYXRhbG9nCi9QYWdlcyAxIDAgUgovVmlld2VyUHJlZmVyZW5jZXMgPDwKL0NlbnRlcldpbmRvdyB0cnVlCi9EaXNwbGF5RG9jVG"
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the followin structure.
{
        ResponseType
      {
            "value": "ER"
      }
      ResponseDetail
      {
            "ErrorCode": "99",
            "ErrorDesc": "BP-CAR no se logró generar el reporte",
            "ErrorType": "GDB"
      }
}

> Diagram of sequence.

-Send Certificates Email

This operation is used to: Send Certificates by Email ..

GET

Request example:

[Call the service to send an email with the certificates]

/documents-management/v2/certificate/{identserialnum}?operation=tc&govIssueIdentType=CC&emailAddress=example@example.com&cellPhone=3111111111

-URI parameters

identserialnum: Contains information related to user identification number . (Required ej, 19444454 )

-Query parameters

acctId: Contains information related to product number. (Only required when operation is tc or pension)

year: Consultation year. (Required ej. 2022)

emailAddress: Customer email address .(Required)

cellPhone: Customer cell phone number, (Required when no email address is provided)

govIssueIdentType: Type of customer identification .(Required)

- CC (Citizenship Card )

- CE (Immigration ID )

- PA ( Passport )

- TI (Identity card)

- NI (NIT)

- PE (Special Stay Permit (for Venezuelans))

operation: Type of certificate (Required)

- tax (tributarias)

- banking (bancarias)

- pension (Comprobante Pensión)

- payments (Proyección de Pagos del Activo)

- tc (Tarjeta de Crédito)

Headers

Headers Invoker

Headers Security

Response information:

This operation is used to query information related to : Certificates .. The objects of the operation are described below:

responseType: Used to return the response type.

stmtRec: Contains information related to statement generated.

 desc: Contains response message.

> Response 200.

  {
    "responseType": {
        "value": "OK"
    },
    "stmtRec":{
      "desc": "Statements were successfully processed"
    }
 }

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the followin structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "000001",
        "errorDesc": "Invalid identification type",
        "errorType": "CED"
    }
}

> Diagram of sequence.

-Consultaton of Certificates

Request example:

GET

Request example 1:

[List of all user certificates :operation, identSerialNum, govIssueIdentType]

/documents-management/v1/certificate/{identserialnum}?operation=certificate&govIssueIdentType=CC

Request example 2:

[Certificates for the entered year: operation, year, identSerialNum, govIssueIdentType]

/documents-management/v1/certificate/{identserialnum}?operation=certificate&govIssueIdentType=CC&month=0&year=2022

Request example 3:

[Certificates for all years for the type of certificate:operation, identSerialNum, govIssueIdentType, certType ]

/documents-management/v1/certificate/{identserialnum}?operation=certificate&govIssueIdentType=CC&certType=T0744

Request example 4:

[Certificates for T074 :operation, identSerialNum, govIssueIdentType, certType=T0749,year,acctId]

/documents-management/v1/certificate/{identserialnum}?operation=certificate&govIssueIdentType=CC&certType=T0749&year=2022&acctId=24026685593

Request example 5:

[Certificates other than T049:operation, identSerialNum, govIssueIdentType, certType, year, acctId]

/documents-management/v1/certificate/{identserialnum}?operation=certificate&govIssueIdentType=CC&certType=T0744&year=2022&acctId=

-URI parameters

identserialnum: Contains information related to user identification number (Required ej, 19444454 )

-Query parameters

acctId: Contains information related to product number. (Optional )

month: Consultation month. (Optional only required for certCode T0747 or T0748 )**

**Applies for Bimonthly T0747 or T0748 Certificate. Value between 1 and 6, according to the following rule.

month 1,2 : bimester is 1

month 3,4 : bimester is 2

month 5,6: bimester is 3

month 7,8: bimester is 4

month 9,10: bimester is 5

month 11,12: bimester is 6

year: Consultation year. (Optional ej. 2022 )

operation: Consultation operation: (Required)

- certificate

govIssueIdentType: Type of customer identification .(Required)

- CC (Citizenship Card )
- CE (Immigration ID )
- PA ( Passport )
- TI (Identity card)
- NI (NIT)
- PE (Special Stay Permit (for Venezuelans))

certCode: Type of certificate ( Optional )

- T0740 : Certificate other credits
- T0741 : Financial Yield Certificate
- T0742 : Lien certificate on financial movements
- T0743 : RACT
- T0744 : Certificate Other Concepts
- T0745 : Certificate of AFC payments
- T0746 : CREE Certificate
- T0747 : IVA withholding certificate (Bimonthly consultation month 1 to 6 ) **
- T0748 : ICA Withholding Certificate (Bimonthly consultation month 1 to 6 ) **
- T0749 : Payment projection
- T0756 : Mortgage Credit Certificate
- T0733 : Trust Certificate RF Surrender
- T0734 : Trust Certificate RF RentaFacil
- T0735 : Universitas RF Fiduciary Certificate
- T0736 : Trust Certificate GMF Surrender
- T0737 : Trust Certificate GMF RentaFacil
- T0738 : GMF Universitas Trust Certificate

Headers

Headers Invoker

Headers Security

Response information:

This operation is used to query information related to : Certificates .. The objects of the operation are described below:

responseType: Used to return the response type.

stmtRec: Contains information related to statement generated.

 externalFileId: Contains information of file Id.
 fileId: Contains information of file Id.
 fileName: Contains information related  to file name.
 month: Contains information related  to month .
 year: Contains information related  to year .
 acctId: Contains information related  to product number.
 path: Contains information related  to path.
 binData: Contains information related the file.
 certType: Contains information related  to certType.

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "certificationDcmnt": [
        {
            "externalFileId": "0-2020-T0742",
            "fileId": "",
            "fileName": "Certificado gravamen sobre movimientos financieros",
            "month": "0",
            "year": "2020",
            "acctId": "",
            "path": "",
            "binData": "",
            "certType": "T0742"
        },
        {
            "externalFileId": "0-2020-T0736",
            "fileId": "",
            "fileName": "Certificado GMF Rendir",
            "month": "0",
            "year": "2020",
            "acctId": "",
            "path": "",
            "binData": "",
            "certType": "T0736"
        },
        {
            "externalFileId": "0-2020-T0737",
            "fileId": "",
            "fileName": "Certificado GMF Rentafácil",
            "month": "0",
            "year": "2020",
            "acctId": "",
            "path": "",
            "binData": "",
            "certType": "T0737"
        },
        {
            "externalFileId": "0-2020-T0738",
            "fileId": "",
            "fileName": "Certificado GMF Universitas",
            "month": "0",
            "year": "2020",
            "acctId": "",
            "path": "",
            "binData": "",
            "certType": "T0738"
        },
        {
            "externalFileId": "0-2020-T0745",
            "fileId": "",
            "fileName": "Certificado Pagos AFC",
            "month": "0",
            "year": "2020",
            "acctId": "",
            "path": "",
            "binData": "",
            "certType": "T0745"
        },
        {
            "externalFileId": "0-2020-T0740",
            "fileId": "",
            "fileName": "Certificado Otros Créditos",
            "month": "0",
            "year": "2020",
            "acctId": "",
            "path": "",
            "binData": "",
            "certType": "T0740"
        }
    ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "000004",
        "errorDesc": "Invalid Product Number",
        "errorType": "CED"
    }
}

> Diagram of sequence.

-Consultaton of Certificates Detail

Request example:

GET

Request example 1: (Annual certificate:operation, year, certType, identSerialNum )

/documents-management/v1/certificate/{identserialnum}?operation=certificateDetail&year=2022&govIssueIdentType=CC&certType=T0744

Request example 2: (Bimonthly T0747 or T0748 Certificate:operation, month,year, certType, identSerialNum )

/documents-management/v1/certificate/{identserialnum}?operation=certificateDetail&month=5&year=2022&govIssueIdentType=CC&certType=T0744

Request example 3: (Bimonthly T0747 or T0748 Certificate:operation, identSerialNum ,externalFileId)

/documents-management/v1/certificate/{identserialnum}?operation=certificateDetail&govIssueIdentType=CC&externalFileId=5-2022-T0744

-URI parameters

identserialnum: Contains information related to user identification number (Required ej, 19444454 )

-Query parameters

acctId: Contains information related to product number. (Optional )

externalFileID: Query made up of {month}-{year}-{certType}

month: Consultation month (bimester). (Optional only required for certCode T0747 or T0748 )**

**Applies for Bimonthly T0747 or T0748 Certificate. Value between 1 and 6, according to the following rule.

month 1,2 : bimester is 1

month 3,4 : bimester is 2

month 5,6: bimester is 3

month 7,8: bimester is 4

month 9,10: bimester is 5

month 11,12: bimester is 6

year: Consultation year. (Optional ej. 2022 )

operation: Consultation operation: (Required)

- certificateDetail

govIssueIdentType: Type of customer identification .(Required)

- CC (Citizenship Card )
- CE (Immigration ID )
- PA ( Passport )
- TI (Identity card)
- NI (NIT)
- PE (Special Stay Permit (for Venezuelans))

certType: Type of certificate ( Optional )

- T0740 : Certificate other credits
- T0741 : Financial Yield Certificate
- T0742 : Lien certificate on financial movements
- T0743 : RACT
- T0744 : Certificate Other Concepts
- T0745 : Certificate of AFC payments
- T0746 : CREE Certificate
- T0747 : IVA withholding certificate (Bimonthly consultation) **
- T0748 : ICA Withholding Certificate (Bimonthly consultation) **
- T0749 : Payment projection
- T0756 : Mortgage Credit Certificate
- T0733 : Trust Certificate RF Surrender
- T0734 : Trust Certificate RF RentaFacil
- T0735 : Universitas RF Fiduciary Certificate
- T0736 : Trust Certificate GMF Surrender
- T0737 : Trust Certificate GMF RentaFacil
- T0738 : GMF Universitas Trust Certificate

Headers

Headers Invoker

Headers Security

This operation is used to query information related to : Certificates .. The objects of the operation are described below:

responseType: Used to return the response type.

certificationDcmnt: Contains information related to certificates detail.

 externalFileId: Contains information of file Id madeup of {month}-{year}-{year}
 fileId: Contains information of file Id.
 fileName: Contains information related  to file name.
 month: Contains information related  to month .
 year: Contains information related  to year .
 acctId: Contains information related  to product number.
 path: Contains information related  to path.
 binData: Contains information related the binary corresponding to the certificate file base 64.

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
"certificationDcmnt": [
        {
    "externalFileId": "5-2022-T0744",
    "fileId": "",
    "fileName": "",
    "month": "0",
    "year": "0",
    "acctId": "",
    "path": "",
    "binData": "JVBERi0xXAR+LPyZD0sqg+HOBqrMUm+orpuQLMQzhPceYk5D7AYQMuIAmMAubKE3Thn30o3T1o4N6nuV4Bkqj9qMgTwzbORCzXUix9F8vpcAPfy90Mr82qvWrUYkS+Qo+LKVuFI9wVT0x/mGI5+Qx41rUt7MFqZD4XGYWmumASbfh0gEVGMYYToSrzjPZw8d7iT5qutmjKVBERTXAR+LPyZD0sqg+HOBqrMUm+orpuQLMQzhPceYk5D7AYQMuIAmMAubKE3Thn30o3T1o4N6nuV4Bkqj9qMgTwzbORCzXUix9F8vpcAPfy90Mr82qvWrUYkS+Qo+LKVuFI9wVT0x/mGI5+Qx41rUt7MFqZD4XGYWmumASbfh0gEVGMYYToSrzjPZw8d7iT5qutmjK"

  ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "000004",
        "errorDesc": "Invalid Product Number",
        "errorType": "CED"
    }
}

> Diagram of sequence.

-Get payment receipts for a pensioner.

GET

/documents-management/v1/document/pensioner-voucher/{identserialnum}/{acctid}

-URI parameters

identserialnum: Contains information related to user identification number (Required ej, 19444454 )

acctid: Contains information related to product number.

-Query parameters

govissueidenttype: Type of customer identification .(Required)

- CC (Citizenship Card )
- CE (Immigration ID )
- PA ( Passport )
- TI (Identity card)
- NI (NIT)
- PE (Special Stay Permit (for Venezuelans))

month: Query made up of {month}

recordsxpage: Number of records to return

initialrecord: Page number

*Response

responseType: Used to return the response type.

resultsPagesGeneric: Pagination Information

totalRecords: Total Number of Records
recordsXPage: Number of Records Returned

transaction[]:

 govIssueIdent:
      govIssueIdentType: User Identification Type
      identSerialNum: User identification number
 year: Payment year
 month: Payment month
 entpr:
      entprDesc: Company
 acctId: Contains information related  to product number.
 curAmt:
      amt: Amount
 trnRqUID: Receipt Number

> Example Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "resultsPagesGeneric": {
        "initialRecord": "1",
        "recordsXPage": "1"
    },
    "transaction": [
        {
            "govIssueIdent": {
                "govIssueIdentType": "CC",
                "identSerialNum": "41336999"
            },
            "year": "2020",
            "month": "05",
            "entpr": {
                "entprDesc": "Colpensiones"
            },
            "acctId": "24024303999",
            "curAmt": {
                "amt": "00000080220300"
            },
            "trnRqUID": "000001034999"
        }
    ]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "000004",
        "errorDesc": "Invalid Product Number",
        "errorType": "CED"
    }
}

> Diagram of sequence.

-Request a bank certificate.

POST

/documents-management/v1/certificate/credit

-Request

govIssueIdent

     **identserialnum:** Contains information related to user identification number **(Required ej, **19444454** )**

     **govissueidenttype: **Type of customer identification** **.**(Required)**

- CC (Citizenship Card )
- CE (Immigration ID )
- PA ( Passport )
- TI (Identity card)
- NI (NIT)
- PE (Special Stay Permit (for Venezuelans))


stmtRec:
 **acctid:** Contains information related to product number. (Required)

certificationDcmnt: Information handling for the transmission of client product extract files, not specific to a product type
 **certType:** • 0154 Bank Certification of Rotating Credit • T0155 Certification of credit card assistance **(Required)**
contactInfo: Contact Information.
 **emailAddr:** Customer email
 **addr1:** Correspondence Address
 **notification:** Notification data
     **emailToInfo:** Email to notify **(Required)**

bankInfo: Information used to identify the bank
 **branchId:** office code

> Example request.

{
  "depAcctId": {
    "acctId": "24026102199"
  },
  "xFerInfo": {
    "amt": 1000,
    "flagTransfer": "D"
  },
  "branch": {
    "branchId": "1102"
  }
}

*Response

responseType: Used to return the response type.

> Example Response 200.

{
"responseType": {
    "value": "OK"
 }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.

{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "000004",
        "errorDesc": "Invalid Product Number",
        "errorType": "CED"
    }
}

> Diagram of sequence.

- Get document (GET):

Description: This service allows you to consult a file document

Path:

/documents-management/v1/pqr/file/{fileId}:

URI Parameters:

fileId: Contains information related to the file ID

Headers:

Headers Invoker

Headers Security

Response information:

file: File object
    processId: Contains information related to ProcessId
    code: Contains information related to Code
    reviewId: Contains information related to reviewId
    status: Status object
        code: Contains information related to Code
        indexed: Contains information related to indexed
        release: Contains information related to release
        processing: Contains information related to processing
        publication: Contains information related to publication
    flagReview: Contains information related to flagReview
    fileType: Contains information related to FileType
    startDt: Contains information related to StartDt
    effDt: Contains information related to EffDt
    flag: Contains information related to flag
    contentType: Contains information related to ContentType
    additionalData: AdditionalData object
        contentType: Contains information related to ContentType
        fileType: Contains information related to FileType
    message: Contains information related to message
    name: Contains information related to Name
    nickname: Contains information related to Nickname
    itemGeneric1: Contains information related to ItemGeneric1
    itemGeneric2: Contains information related to ItemGeneric2
    binLength: Contains information related to BinLength
    documentType: Contains information related to DocumentType
    type: Type object
        publication: Contains information related to publication
    fileDesc: Contains information related to FileDesc
    flagInspected: Contains information related to flagInspected
    modifierUser: Contains information related to ModifierUser
    fileId: Contains information related to FileId
    primary: Contains information related to Primary
    fileName: Contains information related to FileName
    binData: Contains information related to BinData
    folder: folder object
        acctId: Contains information related to AcctId
        createdDt: Contains information related to CreatedDt
        security:
            groupCode: Contains information related to groupCode
        user: Contains information related to User
    property: Type Array
        type: Type object
            code: Contains information related to Code
            name: Contains information related to Name

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "file": {
    "processId": "43862",
    "code": "43103",
    "reviewId": "1",
    "status": {
      "code": "RELEASED",
      "indexed": "",
      "release": "Y",
      "processing": "Y",
      "publication": ""
    },
    "flagReview": "1",
    "fileType": "pdf",
    "startDt": "2019-07-24T15:08:00",
    "effDt": "2019-07-24T15:09:00",
    "flag": "",
    "contentType": "application/pdf",
    "additionalData": {
      "contentType": "0",
      "fileType": "pdf"
    },
    "message": "Correcto",
    "name": "BCS.043103",
    "nickname": "DOCUMENTO_PRUEBA.pdf",
    "itemGeneric1": "T",
    "itemGeneric2": "",
    "binLength": "6463",
    "documentType": "Document",
    "type": {
      "publication": ""
    },
    "fileDesc": "CC-79535521",
    "flagInspected": "0",
    "modifierUser": "",
    "fileId": "69724",
    "primary": "1",
    "fileName": "DOCUMENTO_PRUEBA.pdf",
    "binData": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggNiAwIFIvRmlsdGVyIC9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCtUMNAzNFIwAEEYIzmXy0DBHYjTuQq5LPSMQQAsgcxOzlVwCuHSDzJXsNSzNFMISeMy0LO0tDS2MANLGypYmOoZWCiYmxnqGZkohORyaTBqhmRxuYZwBQIhAGcEFyVlbmRzdHJlYW0KZW5kb2JqCjYgMCBvYmoKOTYKZW5kb2JqCjQgMCBvYmoKPDwvVHlwZS9QYWdlL01lZGlhQm94IFswIDAgNTk1IDg0Ml0KL1JvdGF0ZSAwL1BhcmVudCAzIDAgUgovUmVzb3VyY2VzPDwvUHJvY1NldFsvUERGIC9UZXh0XQovRm9udCA5IDAgUgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFsKNCAwIFIKXSA+CmVuZHN0cmVhbQplbmRvYmoKMiAwIG9iago8PC9Qcm9kdWNlcihHUEwgR2hvc3RzY3JpcHQgOS4wNCkKL0NyZWF0aW9uRGF0ZShEOjIwMTUwODEyMTM0OTI3KzAyJzAwJykKL01vZERhdGUoRDoyMDE1MDgxMjEzNDkyNyswMicwMCcpCi9UaXRsZShcMzc2XDM3N1wwMDBoXDAwMG9cMDAwalwwMDBhXDAwMCBcMDAwZVwwMDBuXDAwMCBcMDAwYlwwMDBsXDAwMGFcMDAwblwwMDBjXDAwMG9cMDAwIFwwMDBwXDAwMGRcMDAwZikKL0NyZWF0b3IoXDM3NlwzNzdcMDAwUFwwMDBEXDAwMEZcMDAwQ1wwMDByXDAwMGVcMDAwYVwwMDB0XDAwMG9cMDAwclwwMDAgXDAwMFZcMDAwZVwwMDByXDAwMHNcMDAwaVwwMDBvXDAwMG5cMDAwIFwwMDAxXDAwMC5cMDAwMlwwMDAuXDAwMDMpCi9BdXRob3IoXDM3NlwzNzdcMDAwalwwMDBjXDAwMG1cMDAwZlwwMDBlXDAwMHJcMDAwblwwMDBhXDAwMG5cMDAwZFwwMDBlXDAwMHopCi9LZXl3b3JkcygpCi9TdWJqZWN0KCk+PmVuZG9iagp4cmVmCjAgMTMKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMzk5IDAwMDAwIG4gCjAwMDAwMDU1ODAgMDAwMDAgbiAKMDAwMDAwMDM0MCAwMDAwMCBuIAowMDAwMDAwMTk5IDAwMDAwIG4gCjAwMDAwMDAwMTUgMDAwMDAgbiAKMDAwMDAwMDE4MSAwMDAwMCBuIAowMDAwMDAwNzE4IDAwMDAwIG4gCjAwMDAwMDA4NjQgMDAwMDAgbiAKMDAwMDAwMDQ2NCAwMDAwMCBuIAowMDAwMDAxMDYyIDAwMDAwIG4gCjAwMDAwMDA0OTMgMDAwMDAgbiAKMDAwMDAwMzkyMiAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDEzIC9Sb290IDEgMCBSIC9JbmZvIDIgMCBSCi9JRCBbPDJGQjBBOEQ4NjdDQTc4MkJGRDU5MDI0RURERDg5NjRBPjwyRkIwQThEODY3Q0E3ODJCRkQ1OTAyNEVEREQ4OTY0QT5dCj4+CnN0YXJ0eHJlZgo2MDUwCiUlRU9GCg==",
    "folder": {
      "acctId": "",
      "createdDt": "2019-07-24T15:08:00",
      "security": {
        "groupCode": "Public"
      },
      "user": "USER-DEFAULT"
    },
    "property": [
      {
        "type": {
          "code": "",
          "name": "xComments"
        }
      },
      {
        "type": {
          "code": "",
          "name": "xExternalDataSet"
        }
      },
      {
        "type": {
          "code": "001",
          "name": "xIdcProfile"
        }
      },
      {
        "type": {
          "code": "",
          "name": "xTemplateType"
        }
      },
      {
        "type": {
          "code": "",
          "name": "xSiSyncToSites"
        }
      },
      {
        "type": {
          "code": "0",
          "name": "xAnnotationDetails"
        }
      },
      {
        "type": {
          "code": "",
          "name": "xParentFolders"
        }
      },
      {
        "type": {
          "code": "0",
          "name": "xIsACLReadOnlyOnUI"
        }
      },
      {
        "type": {
          "code": "0",
          "name": "xIsRecord"
        }
      },
      {
        "type": {
          "code": "1",
          "name": "xIsEditable"
        }
      }
    ]
  }
}

> Error response.

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

> Diagram of sequence.

> Errors Code.

- Document Attach File PQR (POST):

Description:

This operation only allows attaching files (upsertSolicitud).

Path:

/documents-management/v1/pqr/file:

Headers:

Body:

>Request Mapping:

>Example-request:

{
    "transaction": {
        "trnRqUID": "1-265807774",
        "desc": "ARCHIVO_DE_PRUEBA_ADJUNTO_M1"
    },
    "file": {
        "fileType": "docx",
        "fileName": "ARCHIVO_DE_PRUEBA_ADJUNTO_M1",
        "path": "",
        "type": {
            "fileType": "FILE"
        },
        "binData": "cHJ1ZWJhIHNpZWJlbA=="
    }
}

>Response Mapping:

>Example-response:

 {
     "responseType": {
         "value": "OK"
     },
     "transaction":{
       "trnRqUID": "1-265807774",
       "desc" : "",
       "segmentation":{
         "value": "Complaint",
         "value2": "RG_0003",
         "value3": "RG_0003_0001"
       },
       "status":{
         "statusCode": "01"
       },
       "additionalStatus":{
         "statusCode": ""
       }
     }
 }

Diagram of sequence.

Errors Code.

- Send Photos Visits (POST):

Description:

This operation only Send Photos for Visits APP.

Path:

/documents-management/v1/location-visit:

Headers:

Body:

>Request Mapping:

>Example-request:

{
  "trnImage": {
    "refId": "235464564565456545",
    "idItem":"3434",
    "type": "12",
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "12344553"
    },
    "fileName": "examplefilename",
    "binData": "aswr3543sd4fq35t6yfgergw6uwrth6u743t3rgg45357h5h6h6jj47",
    "fileDesc": "descrption of file"
  }
}

>Response Mapping OK:

>Example-response:

 {
  "responseType": {
     "value": "OK"
   }
 }

>Response Mapping Error:

{
  "responseType": {
    "value": "ERR500"
  },
  "responseDetail": {
    "errorCode": 500,
    "errorDesc": "The server encountered an unexpected condition which prevented it from fulfilling the request.",
    "errorType": "Internal Server Error"
  }
}

- Remittances - Consult Tirilla.

Description:

The objective of this service is to generate payment slips for the transactions carried out by the client. The slips are generated only per transaction, therefore, the service will receive the transaction ID and the MTCN as a parameter. The expected response is the strip string in base 64 format which must be converted to PDF.

Path:

GET

/documents-management/v1/remittances/payments/{trnRqUID}?refId={refId}:

URIParams:

QueryParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

{
  "responseType": {
    "value": "OK"
  },
  "trnImage": {
    "binData": "JVBERi0xLjQNCiW0tba3DQolDQoxIDAgb2JqDQo8PA0KL1R5cGUgL0NhdGFsb2cNCi9QYWdlTGF5b3V0IC9PbmVDb2x1bW4NCi9QYWdlTW9kZSAvVXNlTm9uZQ0KL0Rlc3RzIDIgMCBSDQovUGFnZXMgMyAwIFINCjDQoNCmVuZG9iag0KMyAwIG9iag0KPDwNCi9UeX",
    "file": {
      "binData": "JVBERi0xLjQNCiW0tba3DQolDQoxIDAgb2JqDQo8PA0KL1ZpZXdlclByZWZlcmVuY2VzIDIgMCBSDQovUGFnZUxheW91dCAvT25lQ29sdW1uDQovVHlwZSAvQ2F0YWxvZw0KL1BhZ2VzIDMgMCBSDQovUGFnZU1vZGUgL1VzZU5vbmUNCi9EZXN0"
    }
  }
}

Diagrama.