iBanFirst Documents API

openapi: 3.2.0
info:
  version: 1.6.0
  title: iBanFirst Documents API
  description: iBanFirst API for cross-border payments, FX trades, account management, beneficiaries, and webhooks.
servers:
- url: https://api-demo.ibanfirst.com/api
security:
- X-WSSE: []
tags:
- name: Documents
  description: 'The API allows you to access your documents stored on the iBanFirst platform through a one-time access link.


    Documents must be generated on the platform before being available through the API.'
paths:
  /documents:
    get:
      summary: Get documents list
      tags:
      - Documents
      description: This service allows you to retrieve the list of documents available for you on the iBanFirst platform.
      parameters:
      - name: page
        in: query
        description: 'Index of the page.

          '
        required: false
        schema:
          type: string
          default: '1'
      - name: per_page
        in: query
        description: 'Number of items returned.

          '
        required: false
        schema:
          type: string
          default: '50'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/ID'
                    name:
                      description: 'The name of the document.

                        '
                      type: string
                    type:
                      description: 'The type of document.

                        '
                      type: string
                    createdDate:
                      $ref: '#/components/schemas/Datetime'
                    link:
                      description: 'The one-time link to the document.

                        '
                      type: string
        '204':
          description: No documents found
        default:
          description: ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getDocuments
      x-operation-id-source: derived
  /documents/{id}:
    get:
      summary: Get document details
      tags:
      - Documents
      description: Retrieve details for a specific document.
      parameters:
      - name: id
        in: path
        description: 'The unique identifier of the document you want.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        default:
          description: ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getDocumentsById
      x-operation-id-source: derived
  /documents/RIB:
    get:
      summary: Get RIB
      tags:
      - Documents
      description: Retrieve RIB for a specific account.
      parameters:
      - name: walletId
        in: query
        description: 'The account ID for which the RIB is requested.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        default:
          description: ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getDocumentsRIB
      x-operation-id-source: derived
  /documents/upload/{object}/{objectId}/{typeOfDocumentation}:
    put:
      summary: Upload a document
      tags:
      - Documents
      description: 'This service allows you to upload documents.


        For an `externalBankAccount` object type (*beneficiary*), you may only upload an `identity` type of document.


        For a `payment` object type, you may upload either a `identity` or `invoice` type of document.


        To send a file, you have to extract its content in a binary format, encode it with a base64 algorithm and insert the result in the `file` field of the body request.'
      parameters:
      - name: object
        in: path
        description: 'The type of object you want to upload a document on.

          '
        required: true
        schema:
          type: string
          enum:
          - externalBankAccount
          - payment
      - name: objectId
        in: path
        description: 'The unique identifier of the object you want to upload a document on.

          '
        required: true
        schema:
          type: string
      - name: typeOfDocumentation
        in: path
        description: 'The type document you want to upload on your object.

          '
        required: true
        schema:
          type: string
          enum:
          - identity
          - invoice
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - tag
              - file
              properties:
                tag:
                  description: 'The name of the document to be attached.

                    '
                  type: string
                file:
                  description: 'The binary content of the file, encoded with a base64 algorithm.

                    '
                  type: string
        description: 'The document to upload

          '
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        default:
          description: ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: putDocumentsUploadByObjectByObjectIdByTypeOfDocumentation
      x-operation-id-source: derived
components:
  schemas:
    Datetime:
      type: string
      pattern: ^((19[0,99]|2[0-9]{3})\-(0[1-9]|1[012])\-([012][0-9]|3[01])\ ([01][0-9]|2[0-3])\:([0-5][0-9])\:([0-5][0-9]))$
      format: ^((19[0,99]|2[0-9]{3})\-(0[1-9]|1[012])\-([012][0-9]|3[01])\ ([01][0-9]|2[0-3])\:([0-5][0-9])\:([0-5][0-9]))$
      example: '2016-01-01 00:00:00'
      description: 'A String representing a date by its year, month, day in month, hour, minute and second.

        '
    Document:
      type: object
      description: 'Representation of a document.

        '
      properties:
        id:
          $ref: '#/components/schemas/ID'
        name:
          description: 'The name of the document.

            '
          type: string
        type:
          description: 'The type of the document.

            '
          type: string
        createdDate:
          $ref: '#/components/schemas/Datetime'
        lastOpennedDate:
          $ref: '#/components/schemas/Datetime'
        mimeType:
          description: 'The MIME type of the document.

            '
          type: string
        link:
          description: 'The one-time link to access or download the document.

            '
          type: string
    Error:
      type: object
      description: 'Representation of an error.

        '
      properties:
        errorCode:
          type: number
          format: int
          description: 'The code referring the error.

            '
        errorType:
          type: string
          description: 'A short description identifying a general category for the error that occurred.

            '
        errorMessage:
          type: string
          description: Error description.
        link:
          type: string
          description: 'An hyperlink to access the page that describes more accurately the error.

            '
    ID:
      type: string
      pattern: ^[A-Za-z0-9]+$
      format: ^[A-Za-z0-9]+$
      example: Na5Dv6E
      description: 'A String representing the id of an object. This string contains alpha-numeric characters, including the capital ones.

        '
  securitySchemes:
    X-WSSE:
      type: apiKey
      in: header
      name: X-WSSE
      description: 'X-WSSE token-based authentication. The header value must be computed fresh for every request (tokens expire in ~5 minutes).


        Header value format:

        ```

        UsernameToken Username="<username>", PasswordDigest="<digest>", Nonce="<nonce_b64>", Created="<timestamp>"

        ```


        Algorithm:

        1. Generate a random nonce: ≥ 32 lowercase hex characters.

        2. Get current UTC timestamp in ISO 8601: `YYYY-MM-DDTHH:MM:SSZ`.

        3. Compute `PasswordDigest = Base64( SHA-1( nonce_bytes + created_bytes + secret_bytes ) )` — SHA-1 over the raw UTF-8 bytes concatenated in that order, result must be the binary digest before Base64 encoding.

        4. Compute `Nonce = Base64( nonce_utf8_bytes )`.


        See the `info.description` field at the top of this spec for full code samples in Python, JavaScript, PHP, Java, and Go.'