embedOnfido

Overview

This mutation gets credentials and information to embed Onfido's "ID upload" UI.

Special Considerations

  • Works with Onfido, a third-party document ID & facial biometrics company.

Inputs

None.

Returns

Promise<OnfidoEmbedPayload>

A promise containing the following object / data:

sdkToken: string
applicantId: string

Example

Running this mutation:

mutation {
  embedOnfido {
    sdkToken
    applicantId
  }
}

Gives us:

{
    "data": {
        "embedOnfido": {
        "sdkToken": "eyJhbGciOiJIUzI1NiJ9.eyJwYXlsb2FkIjoiMmpWRTVINXE3dE1CMnZEQ2IxTGgwRGo3c2ZnSTl0R2c3K3NZOEdSSE9rTEUxZFlNcUdCeE1lWHFZYlk4XG4vR28rNWs1VWVPUmFacWNmNWdROStZdEt4NmVlMkw4aUJCSkEvNHhzdGVpS3VHVT1cbiIsInV1aWQiOiJ6a1VJRVptYXNTZyIsImV4cCI6MTU5MTg5NDY0NCwidXJscyI6eyJvbmZpZG9fYXBpX3VybCI6Imh0dHBzOi8vYXBpLm9uZmlkby5jb20iLCJ0ZWxlcGhvbnlfdXJsIjoiaHR0cHM6Ly90ZWxlcGhvbnkub25maWRvLmNvbSIsImRldGVjdF9kb2N1bWVudF91cmwiOiJodHRwczovL3Nkay5vbmZpZG8uY29tIiwic3luY191cmwiOiJodHRwczovL3N5bmMub25maWRvLmNvbSIsImhvc3RlZF9zZGtfdXJsIjoiaHR0cHM6Ly9pZC5vbmZpZG8uY29tIn19.GTiXfa3q4WVw5glj3sTPyfItr_y3ouxMenvn7BhIUB8",
        "applicantId": "9641c31b-55a1-4601-85cf-976154247d8c"
        }
    }
}

Common Errors

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

  • There was an error creating a token. (E-6002)
    • Third-party error. Couldn't embed Onfido ID verification UI.
← addOnfidoDocumentToPersonNext →