onfido_v3

v0.1.3

onfido_v3 v0.1.3 Onfido.Resources.Check

Link to this section Summary

Functions

create(params)

Create a check for an applicant

get(check_id)

Get a check for an applicant

list(applicant_id)

List checks for an applicant

resume(check_id, params \\ %{})

Resume a check for an applicant

Link to this section Functions

Link to this function

create(params)

Create a check for an applicant

Example 

  Onfido.Resources.Check.create(%{
    applicant_id: "<applicant_id>",
    report_names: [
      "document",
      "facial_similarity_photo"
    ]
  })
Link to this function

get(check_id)

Get a check for an applicant

Example 

  Onfido.Resources.Check.get("<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(check_id, params \\ %{})

Resume a check for an applicant

Example 

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