Skip to content
For LLMsView as Markdown·

Veriff ​

Identity verification with document scanning, biometric checks, and PEP/sanctions screening.

DetailValue
CategoryiGaming
Base URLhttps://stationapi.veriff.com
AuthenticationHMAC-SHA256
Endpoints8
Connector keyveriff

Using Veriff in a workflow ​

  1. Go to Connections and click New Connection.
  2. Pick Veriff 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 ​

EndpointSummary
POST /v1/sessionsCreate verification session
PATCH /v1/sessions/{sessionId}Submit session for verification
DELETE /v1/sessions/{sessionId}Delete session
POST /v1/sessions/{sessionId}/mediaUpload documents
GET /v1/sessions/{sessionId}/decisionGet verification decision
GET /v1/sessions/{sessionId}/attemptsGet attempt IDs
GET /v1/sessions/{sessionId}/personGet verified person data
GET /v1/sessions/{sessionId}/watchlist-screeningPEP/sanctions results

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

POST /v1/sessions ​

Create verification session

DetailValue
Operation IDkyc.createSession
MethodPOST
Path/v1/sessions

Parameters ​

No parameters.

Request Body ​

FieldType
verificationobject

Using this endpoint in a workflow ​

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

PATCH /v1/sessions/{sessionId} ​

Submit session for verification

DetailValue
Operation IDkyc.submitSession
MethodPATCH
Path/v1/sessions/{sessionId}

Parameters ​

NameLocationTypeRequired
sessionIdpathstringYes

Using this endpoint in a workflow ​

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

DELETE /v1/sessions/{sessionId} ​

Delete session

DetailValue
Operation IDkyc.deleteSession
MethodDELETE
Path/v1/sessions/{sessionId}

Parameters ​

NameLocationTypeRequired
sessionIdpathstringYes

Using this endpoint in a workflow ​

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

POST /v1/sessions/{sessionId}/media ​

Upload documents

DetailValue
Operation IDkyc.uploadDocuments
MethodPOST
Path/v1/sessions/{sessionId}/media

Parameters ​

NameLocationTypeRequired
sessionIdpathstringYes

Using this endpoint in a workflow ​

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

GET /v1/sessions/{sessionId}/decision ​

Get verification decision

DetailValue
Operation IDkyc.getDecision
MethodGET
Path/v1/sessions/{sessionId}/decision

Parameters ​

NameLocationTypeRequired
sessionIdpathstringYes

Using this endpoint in a workflow ​

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

GET /v1/sessions/{sessionId}/attempts ​

Get attempt IDs

DetailValue
Operation IDkyc.getAttempts
MethodGET
Path/v1/sessions/{sessionId}/attempts

Parameters ​

NameLocationTypeRequired
sessionIdpathstringYes

Using this endpoint in a workflow ​

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

GET /v1/sessions/{sessionId}/person ​

Get verified person data

DetailValue
Operation IDkyc.getVerifiedPerson
MethodGET
Path/v1/sessions/{sessionId}/person

Parameters ​

NameLocationTypeRequired
sessionIdpathstringYes

Using this endpoint in a workflow ​

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

GET /v1/sessions/{sessionId}/watchlist-screening ​

PEP/sanctions results

DetailValue
Operation IDkyc.getWatchlistScreening
MethodGET
Path/v1/sessions/{sessionId}/watchlist-screening

Parameters ​

NameLocationTypeRequired
sessionIdpathstringYes

Using this endpoint in a workflow ​

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