Currencycloud Document Images API
The Document Images API from Currencycloud — 2 operation(s) for document images.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/currencycloud:currencycloud-document-images-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: api-onboarding Document Images 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: Document Images
paths:
/v1/forms/{form_id}/documents/{document_id}/document_images:
post:
summary: Create Document Image
description: Records an image of a document that's required for the specified application form. For more information, see the "Uploading documents" section of our guide.
tags:
- Document Images
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
description: Document UUID
required: true
schema:
type: string
responses:
'201':
description: Document image attached
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/document_image'
'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'
'400':
description: Invalid side in request params
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/create_document_image_request'
operationId: postV1FormsByFormIdDocumentsByDocumentIdDocumentImages
x-operation-id-source: derived
get:
summary: Get Document Images
description: Returns all document images for the specified document.
tags:
- Document Images
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
description: Document UUID
required: true
schema:
type: string
responses:
'200':
description: Retrieves document images
content:
application/json:
schema:
type: object
properties:
document_images:
type: array
items:
$ref: '#/components/schemas/document_image'
'404':
description: Document image not found with incorrect form id
content:
application/json:
schema:
$ref: '#/components/schemas/not_found_response'
operationId: getV1FormsByFormIdDocumentsByDocumentIdDocumentImages
x-operation-id-source: derived
/v1/forms/{form_id}/documents/{document_id}/document_images/{document_image_id}:
delete:
summary: Delete Document Image
description: Deletes the specified image of a document attached to the specified form.
tags:
- Document Images
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
description: Document UUID
required: true
schema:
type: string
- name: document_image_id
description: Document Image UUID.
in: path
required: true
schema:
type: string
responses:
'200':
description: Deletes the document image
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
message:
type: string
document_image_id:
description: Document Image UUID.
type: string
required:
- message
- document_image_id
'422':
description: Form is already submitted
content:
application/json:
schema:
$ref: '#/components/schemas/validation_error_response'
'404':
description: Document image not found
content:
application/json:
schema:
$ref: '#/components/schemas/not_found_response'
operationId: deleteV1FormsByFormIdDocumentsByDocumentIdDocumentImagesByDocumentImageId
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
create_document_image_request:
type: object
properties:
image:
description: Image encoder used e.g. base64.
type: string
format: byte
side:
description: Image of which document side.
type: string
enum:
- front
- back
- face
required:
- image
- side
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
document_image:
type: object
properties:
id:
type: string
description: Document image UUID.
side:
type: string
description: Image of which document side.
created_at:
description: Date the document image entity was created.
type: string
format: date-time
updated_at:
description: Date the document image entity was last updated.
type: string
format: date-time
securitySchemes:
AuthToken:
type: apiKey
in: header
name: X-Auth-Token