onfido_v3

v0.1.3

onfido_v3 v0.1.3 Onfido.Resources.Document

Link to this section Summary

Functions

download(applicant_id, document_id)

Download document for a given applicant

get(document_id)

Get document for a given applicant

list(applicant_id)

List documents for a given applicant

upload(params)

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(document_id)

Get document for a given applicant.

Example 

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

list(applicant_id)

List documents for a given applicant.

Example 

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

upload(params)

Upload document for a given applicant.

Example 

  Onfido.Resources.Document.upload(%{
    applicant_id: "<applicant_id>",
    file: "...",
    type: "passport",
    side: "front",
    issuing_country: "GBP"
  })