addOnfidoDocumentToPerson

Overview

This mutation connects an uploaded ID via OnfidoUI and returns a success/failure message. Essentially, the ID the user selected is uploaded and associated with the account.

Special Considerations

N/A

Inputs

addOnfidoDocumentToPersonArgs

Required Data

applicantId: string

Returns

Promise<SuccessResult>

A promise containing the following object / data:

message: string

Example

Running this mutation:

mutation {
  addOnfidoDocumentToPerson (applicantId: "00e18e07-cf67-4208-853c-0d8265af99c6") {
    message
  }
}

Gives us:

{
  "data": {
    "addOnfidoDocumentToPerson": {
      "message": "Id successfully added!"
    }
  }
}

Common Errors

When running this mutation some of the common errors encountered include:

  • This user already has an uploaded id! (code-I-4405)
    • An ID has already been uploaded for the user with borderless
← PreviousembedOnfido →