Onfido

Identity verification and KYC checks with document and biometric analysis.

Detail	Value
Category	iGaming
Base URL	https://api.onfido.com/v3.6
Authentication	Bearer Token
Endpoints	6
Connector key	onfido

Using Onfido in a workflow

1. Go to Connections and click New Connection.
2. Pick Onfido from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

Endpoint	Summary
POST /applicants	Create an applicant
GET /applicants/{applicant_id}	Get an applicant
POST /documents	Upload a document
POST /checks	Create a verification check
GET /checks/{check_id}	Get check status
GET /reports/{report_id}	Get a report

Each endpoint is documented in full below. Use the outline on the right to jump to one.

POST /applicants

Create an applicant

Detail	Value
Operation ID	kyc.createApplicant
Method	POST
Path	/applicants

Parameters

No parameters.

Request Body

Field	Type
first_name	string
last_name	string
email	string
dob	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Onfido connection from the Connection dropdown.
3. In the Operation dropdown, select kyc.createApplicant.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Onfido API reference.

GET /applicants/{applicant_id}

Get an applicant

Detail	Value
Operation ID	kyc.getApplicant
Method	GET
Path	/applicants/{applicant_id}

Parameters

Name	Location	Type	Required
applicant_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Onfido connection from the Connection dropdown.
3. In the Operation dropdown, select kyc.getApplicant.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Onfido API reference.

POST /documents

Upload a document

Detail	Value
Operation ID	kyc.uploadDocument
Method	POST
Path	/documents

Parameters

No parameters.

Request Body

Field	Type
applicant_id	string
type	string
file	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Onfido connection from the Connection dropdown.
3. In the Operation dropdown, select kyc.uploadDocument.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Onfido API reference.

POST /checks

Create a verification check

Detail	Value
Operation ID	kyc.createCheck
Method	POST
Path	/checks

Parameters

No parameters.

Request Body

Field	Type
applicant_id	string
report_names	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Onfido connection from the Connection dropdown.
3. In the Operation dropdown, select kyc.createCheck.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Onfido API reference.

GET /checks/{check_id}

Get check status

Detail	Value
Operation ID	kyc.getCheck
Method	GET
Path	/checks/{check_id}

Parameters

Name	Location	Type	Required
check_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Onfido connection from the Connection dropdown.
3. In the Operation dropdown, select kyc.getCheck.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Onfido API reference.

GET /reports/{report_id}

Get a report

Detail	Value
Operation ID	kyc.getReport
Method	GET
Path	/reports/{report_id}

Parameters

Name	Location	Type	Required
report_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Onfido connection from the Connection dropdown.
3. In the Operation dropdown, select kyc.getReport.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Onfido API reference.