Skip to content

GET /checks/{check_id} ​

Get check status

DetailValue
Operation IDkyc.getCheck
MethodGET
Path/checks/{check_id}
ConnectorOnfido

Parameters ​

NameLocationTypeRequired
check_idpathstringYes

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.