Onfido Photos API
The Photos API from Onfido — 6 operation(s) for photos.
The Photos API from Onfido — 6 operation(s) for photos.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/onfido-photos-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
contact:
name: Onfido
url: https://public.support.onfido.com
description: 'Create trust at onboarding and beyond with a complete, AI-powered digital
identity solution built to help you know your customers online.
Automation allows you to acquire new customers and reduce costs while
meeting global KYC and AML compliance.'
license:
name: MIT
title: Onfido Photos API
version: v3.6
servers:
- url: https://api.{region}.onfido.com/v3.6
variables:
region:
default: eu
enum:
- eu
- us
- ca
security:
- Token: []
tags:
- name: Photos
paths:
/id_photos:
get:
description: Lists the ID photos that belong to an applicant.
operationId: list_id_photos
parameters:
- description: The id of the applicant the ID photos belong to.
in: query
name: applicant_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Id_Photos_list'
description: An array of ID photos
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: List ID photos
tags:
- Photos
post:
description: You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
operationId: upload_id_photo
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/id_photo_uploader'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/id_photo'
description: The ID photo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Upload ID photo
tags:
- Photos
/id_photos/{id_photo_id}:
get:
description: Retrieves a single ID photo. Returns a ID photo object.
operationId: find_id_photo
parameters:
- description: The ID photo's unique identifier.
in: path
name: id_photo_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/id_photo'
description: A ID photo
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Retrieve ID photo
tags:
- Photos
/id_photos/{id_photo_id}/download:
get:
description: ID photos are downloaded using this endpoint.
operationId: download_id_photo
parameters:
- description: The ID photo's unique identifier.
in: path
name: id_photo_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
'*/*':
schema:
format: binary
type: string
description: The ID photo's binary data.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Download ID photo
tags:
- Photos
components:
schemas:
Error:
example:
error:
type: type
message: message
fields:
key: ''
properties:
error:
$ref: '#/components/schemas/ErrorProperties'
title: Error
type: object
id_photo_uploader:
allOf:
- $ref: '#/components/schemas/id_photo_request'
required:
- applicant_id
- file
ErrorProperties:
example:
type: type
message: message
fields:
key: ''
properties:
type:
type: string
message:
type: string
fields:
additionalProperties: true
type: object
title: ErrorProperties
type: object
id_photo_response:
properties:
id:
description: The unique identifier for the photo.
format: uuid
type: string
created_at:
description: The date and time at which the photo was uploaded.
format: date-time
type: string
href:
description: The uri of this resource.
type: string
download_href:
description: The uri that can be used to download the photo.
type: string
file_name:
description: The name of the uploaded file.
type: string
file_type:
description: The file type of the uploaded file.
type: string
file_size:
description: The size of the file in bytes.
type: integer
required:
- id
type: object
id_photo:
allOf:
- $ref: '#/components/schemas/id_photo_response'
example:
download_href: download_href
file_name: file_name
file_type: file_type
created_at: '2000-01-23T04:56:07.000Z'
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
href: href
file_size: 0
id_photo_request:
properties:
applicant_id:
description: The ID of the applicant whose ID photo is being uploaded.
format: uuid
type: string
file:
description: The file to be uploaded.
format: binary
type: string
type: object
Id_Photos_list:
example:
id_photos:
- download_href: download_href
file_name: file_name
file_type: file_type
created_at: '2000-01-23T04:56:07.000Z'
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
href: href
file_size: 0
- download_href: download_href
file_name: file_name
file_type: file_type
created_at: '2000-01-23T04:56:07.000Z'
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
href: href
file_size: 0
properties:
id_photos:
items:
$ref: '#/components/schemas/id_photo'
type: array
required:
- id_photos
title: Id Photos list
type: object
securitySchemes:
Token:
in: header
name: Authorization
type: apiKey
externalDocs:
url: https://documentation.onfido.com