Sumsub

KYC/AML identity verification with document checks, liveness detection, and compliance screening.

Detail	Value
Category	iGaming
Base URL	`https://api.sumsub.com`
Authentication	HMAC-SHA256
Endpoints	8
Connector key	`sumsub`

Using Sumsub in a workflow

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

Available endpoints

Endpoint	Summary
`POST /resources/applicants`	Create applicant
`GET /resources/applicants/{applicantId}`	Get applicant
`POST /resources/applicants/{applicantId}/info/idDoc`	Upload ID document
`POST /resources/applicants/{applicantId}/status/pending`	Request verification
`GET /resources/applicants/{applicantId}/status/api`	Get review status
`POST /resources/applicants/{applicantId}/aml/check`	Run AML check
`GET /resources/applicants/{applicantId}/review/history`	Review history
`GET /resources/applicants/{applicantId}/requiredIdDocsStatus`	Verification step status

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

POST /resources/applicants

Create applicant

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

Parameters

No parameters.

Request Body

Field	Type
`externalUserId`	string
`info`	object
`requiredIdDocs`	object

Using this endpoint in a workflow

Add an API Call node to your workflow.
Pick your Sumsub connection from the Connection dropdown.
In the Operation dropdown, select kyc.createApplicant.
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 Sumsub API reference.

GET /resources/applicants/{applicantId}

Get applicant

Detail	Value
Operation ID	`kyc.getApplicant`
Method	`GET`
Path	`/resources/applicants/{applicantId}`

Parameters

Name	Location	Type	Required
`applicantId`	path	string	Yes

Using this endpoint in a workflow

Add an API Call node to your workflow.
Pick your Sumsub connection from the Connection dropdown.
In the Operation dropdown, select kyc.getApplicant.
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 Sumsub API reference.

POST /resources/applicants/{applicantId}/info/idDoc

Upload ID document

Detail	Value
Operation ID	`kyc.uploadIdDocument`
Method	`POST`
Path	`/resources/applicants/{applicantId}/info/idDoc`

Parameters

Name	Location	Type	Required
`applicantId`	path	string	Yes

Using this endpoint in a workflow

Add an API Call node to your workflow.
Pick your Sumsub connection from the Connection dropdown.
In the Operation dropdown, select kyc.uploadIdDocument.
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 Sumsub API reference.

POST /resources/applicants/{applicantId}/status/pending

Request verification

Detail	Value
Operation ID	`kyc.requestVerification`
Method	`POST`
Path	`/resources/applicants/{applicantId}/status/pending`

Parameters

Name	Location	Type	Required
`applicantId`	path	string	Yes

Using this endpoint in a workflow

Add an API Call node to your workflow.
Pick your Sumsub connection from the Connection dropdown.
In the Operation dropdown, select kyc.requestVerification.
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 Sumsub API reference.

GET /resources/applicants/{applicantId}/status/api

Get review status

Detail	Value
Operation ID	`kyc.getReviewStatus`
Method	`GET`
Path	`/resources/applicants/{applicantId}/status/api`

Parameters

Name	Location	Type	Required
`applicantId`	path	string	Yes

Using this endpoint in a workflow

Add an API Call node to your workflow.
Pick your Sumsub connection from the Connection dropdown.
In the Operation dropdown, select kyc.getReviewStatus.
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 Sumsub API reference.

POST /resources/applicants/{applicantId}/aml/check

Run AML check

Detail	Value
Operation ID	`kyc.runAmlCheck`
Method	`POST`
Path	`/resources/applicants/{applicantId}/aml/check`

Parameters

Name	Location	Type	Required
`applicantId`	path	string	Yes

Using this endpoint in a workflow

Add an API Call node to your workflow.
Pick your Sumsub connection from the Connection dropdown.
In the Operation dropdown, select kyc.runAmlCheck.
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 Sumsub API reference.

GET /resources/applicants/{applicantId}/review/history

Review history

Detail	Value
Operation ID	`kyc.getReviewHistory`
Method	`GET`
Path	`/resources/applicants/{applicantId}/review/history`

Parameters

Name	Location	Type	Required
`applicantId`	path	string	Yes

Using this endpoint in a workflow

Add an API Call node to your workflow.
Pick your Sumsub connection from the Connection dropdown.
In the Operation dropdown, select kyc.getReviewHistory.
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 Sumsub API reference.

GET /resources/applicants/{applicantId}/requiredIdDocsStatus

Verification step status

Detail	Value
Operation ID	`kyc.getVerificationStepStatus`
Method	`GET`
Path	`/resources/applicants/{applicantId}/requiredIdDocsStatus`

Parameters

Name	Location	Type	Required
`applicantId`	path	string	Yes

Using this endpoint in a workflow

Add an API Call node to your workflow.
Pick your Sumsub connection from the Connection dropdown.
In the Operation dropdown, select kyc.getVerificationStepStatus.
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 Sumsub API reference.

Sumsub ​

Using Sumsub in a workflow ​

Available endpoints ​

POST /resources/applicants ​

Parameters ​

Request Body ​

Using this endpoint in a workflow ​

What it returns ​

GET /resources/applicants/{applicantId} ​

Parameters ​

Using this endpoint in a workflow ​

What it returns ​

POST /resources/applicants/{applicantId}/info/idDoc ​

Parameters ​

Using this endpoint in a workflow ​

What it returns ​

POST /resources/applicants/{applicantId}/status/pending ​

Parameters ​

Using this endpoint in a workflow ​

What it returns ​

GET /resources/applicants/{applicantId}/status/api ​

Parameters ​

Using this endpoint in a workflow ​

What it returns ​

POST /resources/applicants/{applicantId}/aml/check ​

Parameters ​

Using this endpoint in a workflow ​

What it returns ​

GET /resources/applicants/{applicantId}/review/history ​

Parameters ​

Using this endpoint in a workflow ​

What it returns ​

GET /resources/applicants/{applicantId}/requiredIdDocsStatus ​

Parameters ​

Using this endpoint in a workflow ​

What it returns ​

Sumsub

Using Sumsub in a workflow

Available endpoints

POST /resources/applicants

Parameters

Request Body

Using this endpoint in a workflow

What it returns

GET /resources/applicants/{applicantId}

Parameters

Using this endpoint in a workflow

What it returns

POST /resources/applicants/{applicantId}/info/idDoc

Parameters

Using this endpoint in a workflow

What it returns

POST /resources/applicants/{applicantId}/status/pending

Parameters

Using this endpoint in a workflow

What it returns

GET /resources/applicants/{applicantId}/status/api

Parameters

Using this endpoint in a workflow

What it returns

POST /resources/applicants/{applicantId}/aml/check

Parameters

Using this endpoint in a workflow

What it returns

GET /resources/applicants/{applicantId}/review/history

Parameters

Using this endpoint in a workflow

What it returns

GET /resources/applicants/{applicantId}/requiredIdDocsStatus

Parameters

Using this endpoint in a workflow

What it returns