Currencycloud

Currencycloud Documents API

The Documents API from Currencycloud — 2 operation(s) for documents.

GitHub OpenAPI

Operations 3

POST /v1/forms/{form_id}/documents Create Document #
GET /v1/forms/{form_id}/documents Get Documents #
DELETE /v1/forms/{form_id}/documents/{document_id} Delete Document #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/currencycloud/refs/heads/main/openapi/currencycloud-documents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/currencycloud/refs/heads/main/json-schema/currencycloud-create-document-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/currencycloud/refs/heads/main/json-schema/currencycloud-document-with-image-ids-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/currencycloud/refs/heads/main/json-schema/currencycloud-document-schema.json

Other Resources

🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/currencycloud/refs/heads/main/sandbox/currencycloud-sandbox.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/currencycloud:currencycloud-documents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

currencycloud-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: api-onboarding Documents API
  version: v1
servers:
- url: /onboarding
  description: Relative URL
- url: https://api.currencycloud.com/onboarding
  description: Production server (uses live data)
- url: https://devapi.currencycloud.com/onboarding
  description: Dev server (uses test data)
tags:
- name: Documents
paths:
  /v1/forms/{form_id}/documents:
    post:
      summary: Create Document
      description: Adds a validation document to the specified form. For more information on uploading documents, see our guide.
      tags:
      - Documents
      x-api-group: Onboard
      security:
      - AuthToken: []
      parameters:
      - name: form_id
        description: Form UUID
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Creates a document when correct params are provided
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/document'
        '422':
          description: Form is already submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validation_error_response'
        '400':
          description: Invalid parameter in request params
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validation_error_response'
        '404':
          description: Form not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/not_found_response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_document_request'
      operationId: postV1FormsByFormIdDocuments
      x-operation-id-source: derived
    get:
      summary: Get Documents
      description: Returns the uploaded documents for the specified application form.
      tags:
      - Documents
      x-api-group: Onboard
      security:
      - AuthToken: []
      parameters:
      - name: form_id
        description: Form UUID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieves all form documents
          content:
            application/json:
              schema:
                type: object
                properties:
                  documents:
                    type: array
                    items:
                      $ref: '#/components/schemas/document_with_image_ids'
        '404':
          description: Form not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/not_found_response'
      operationId: getV1FormsByFormIdDocuments
      x-operation-id-source: derived
  /v1/forms/{form_id}/documents/{document_id}:
    delete:
      summary: Delete Document
      description: Deletes a document attached to the specified application form.
      tags:
      - Documents
      x-api-group: Onboard
      security:
      - AuthToken: []
      parameters:
      - name: form_id
        description: Form UUID
        in: path
        required: true
        schema:
          type: string
      - name: document_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deletes the document
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                      document_id:
                        type: string
                    required:
                    - message
                    - document_id
        '422':
          description: Form is already submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validation_error_response'
        '404':
          description: Document not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/not_found_response'
      operationId: deleteV1FormsByFormIdDocumentsByDocumentId
      x-operation-id-source: derived
components:
  schemas:
    validation_error_response:
      type: object
      properties:
        status:
          type: string
        error_code:
          type: string
        reason:
          type: string
        error_messages:
          type: object
      required:
      - status
      - error_code
      - reason
      - error_messages
    document:
      type: object
      properties:
        id:
          type: string
        document_type:
          type: string
        category:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - document_type
      - category
    not_found_response:
      type: object
      properties:
        status:
          type: string
        error_code:
          type: string
        reason:
          type: string
        error_messages:
          type:
          - object
          - 'null'
      required:
      - status
      - error_code
      - reason
      - error_messages
    create_document_request:
      type: object
      properties:
        document_type:
          description: The type of document.
          type: string
          enum:
          - bank_statement
          - biometric_state_id
          - driving_licence
          - mortgage
          - passport
          - proof_of_business_activity
          - proof_of_business_identity
          - proof_of_directors
          - proof_of_owners
          - proof_of_source_of_funds
          - residence_id
          - state_id
          - supporting
          - unknown
          - utility_bill
          - visa
        category:
          type: string
          description: Category of identification documentation.
          enum:
          - proof_of_address
          - proof_of_business_activity
          - proof_of_business_identity
          - proof_of_directors
          - proof_of_identity
          - proof_of_owners
          - proof_of_source_of_funds
          - supporting
      required:
      - document_type
      - category
    document_with_image_ids:
      type: object
      properties:
        id:
          type: string
        document_type:
          type: string
        category:
          type: string
        document_image_ids:
          type: array
          items:
            type: string
        form_section_type:
          type:
          - string
          - 'null'
        form_section_id:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - document_type
      - category
  securitySchemes:
    AuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token