Get File

To get a file of a node, could be a PDF or other depending the options

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Intro

With this API you can recover all the documents that have been generated in the execution of a workfloo.

Important Points

Path Parameter

workflooId
It is necessary to send the Identifier of the workfloo from which you want to recover the documents.

Query Parameters

nodeId

Each step executed in workfloo has an identifier called node Id, you can identify this ID in this section:

You need to have this identifier to send it to this service to indicate which node we are going to extract the document from.

name

You must provide the name of type document you want to download, the following values ​​are available.

  • PDF: If a workfloo step returns a PDF, this is the option to download it, it applies to the services that consult the Credit Bureau and Credit Circle.
  • PDF_KIBAN: If a workfloo step returns a PDF, this is the option to download it with kiban's format, it applies only to Credit Circle.
  • REQUEST_INTL: Original query file sent to the credit bureau
  • RESPONSE_INTL: Original response file received by credit bureau
  • REQUEST_XML: Original query file sent to credit circle
  • RESPONSE_XML: Original response file received by credit circle

Response

If you provide an Id that does not exist, as a wrong response you will receive an HTTP code 404 without a body.

Kiban will return the step by step data for the specific workfloo id, to see examples please review the RESPONSE examples:

Path Params
string
required

workfloo execution identifier

Query Params
string
required
Defaults to 1716421107032131

indicate the id of the step (node) executed

string
required
Defaults to PDF

Indicate the type of document to download, e.g. PDF, REQUEST_INTL, RESPONSE_INTL, REQUEST_XML, RESPONSE_XML

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain