Update a VerificationSession 

Updates a VerificationSession object.

When the session status is requires_input, you can use this method to update the verification check and options.

Parameters

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

• optionsobject

  A set of options for the session’s verification checks.

  Hide child parameters

  • options.documentobject

    Options that apply to the document check.

    Hide child parameters

    • options.document.allowed_typesarray of enums

      Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.

      Possible enum values

      driving_license Drivers license document type.

      id_card ID card document type.

      passport Passport document type.

    • options.document.require_id_numberboolean

      Collect an ID number and perform an ID number check with the document’s extracted name and date of birth.

    • options.document.require_live_captureboolean

      Disable image uploads, identity document images have to be captured using the device’s camera.

    • options.document.require_matching_selfieboolean

      Capture a face image and perform a selfie check comparing a photo ID and a picture of your user’s face. Learn more.

• provided_detailsobject

  Details provided about the user being verified. These details may be shown to the user.

  Hide child parameters

  • provided_details.emailstring

    Email of user being verified

  • provided_details.phonestring

    Phone number of user being verified

• typeenum

  The type of verification check to be performed.

  Possible enum values

  document Document check.

  id_number ID number check.