onfido v0.2.0 Onfido.Resources.Document

Link to this section Summary

Functions

Download document for a given applicant

Get document for a given applicant

List documents for a given applicant

Upload document for a given applicant

Link to this section Functions

Link to this function

download(applicant_id, document_id)

Download document for a given applicant.

Example

  Onfido.Resources.Document.download("<applicant-id>", "<document-id>")
Link to this function

get(applicant_id, document_id)

Get document for a given applicant.

Example

  Onfido.Resources.Document.get("<applicant-id>", "<document-id>")
Link to this function

list(applicant_id, document_id)

List documents for a given applicant.

Example

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

upload(applicant_id, params)

Upload document for a given applicant.

Example

  Onfido.Resources.Document.update("<applicant-id>, %{
    file: "...",
    type: "passport",
    side: "front",
    issuing_country: "GBP"
  })