onfido

v0.2.0

onfido v0.2.0 Onfido.Resources.Check

Link to this section Summary

Functions

create(applicant_id, params)

Create a check for an applicant

get(applicant_id, check_id)

Get a check for an applicant

list(applicant_id)

List checks for an applicant

resume(applicant_id, check_id, params \\ %{})

Resume a check for an applicant

Link to this section Functions

Link to this function

create(applicant_id, params)

Create a check for an applicant

Example 

  Onfido.Resources.Check.create("<applicant-id>", %{
    type: "standard",
    async: true
  })
Link to this function

get(applicant_id, check_id)

Get a check for an applicant

Example 

  Onfido.Resources.Check.create("<applicant-id>", "<check-id>")
Link to this function

list(applicant_id)

List checks for an applicant

Example 

  Onfido.Resources.Check.list("<applicant-id>")
Link to this function

resume(applicant_id, check_id, params \\ %{})

Resume a check for an applicant

Example 

  Onfido.Resources.Check.resume("<applicant-id>", "<check-id>")