onfido v0.2.0 Onfido.Resources.Applicant

Link to this section Summary

Functions

create(params)

Create an applicant

delete(applicant_id)

Delete an existing applicant

get(id)

Get an applicant

list(params)

List an applicants

restore(applicant_id, params \\ %{})

Restore applicants that are scheduled for deletion

update(applicant_id, params)

Update an existing applicant

Link to this section Functions

create(params)

Create an applicant.

Example

  Onfido.Resources.Applicant.create(%{
    first_name: "Joe",
    last_name: "Bloggs",
    email: "joe@email.com",
    addresses: [%{
      flat_number: null,
      building_number: "100",
      building_name: null,
      street: "Main Street",
      sub_street: null,
      town: "London",
      state: null,
      postcode: "SW4 6EH",
      country: "GBR",
      start_date: "2013-08-10",
      end_date: null
    }]
  })

delete(applicant_id)

Delete an existing applicant

Example

  Onfido.Resources.Applicant.delete("<applicant-id>")

get(id)

Get an applicant

Example

  Onfido.Resources.Applicant.get("<applicant-id>")

list(params)

List an applicants

Example

  Onfido.Resources.Applicant.list(include_deleted: true)

restore(applicant_id, params \\ %{})

Restore applicants that are scheduled for deletion

Example

  Onfido.Resources.Applicant.restore("<applicant-id>")

update(applicant_id, params)

Update an existing applicant.

Example

  Onfido.Resources.Applicant.update("<applicant-id>", %{
    first_name: "Joe",
    last_name: "Bloggs",
    email: "joe@email.com",
    addresses: [%{
      flat_number: null,
      building_number: "100",
      building_name: null,
      street: "Main Street",
      sub_street: null,
      town: "London",
      state: null,
      postcode: "SW4 6EH",
      country: "GBR",
      start_date: "2013-08-10",
      end_date: null
    }]
  })