Verification Session

Verification Session snapshot for identity.verification_session events.

  • id
    Type: string
    required

    Verification Session ID.

  • created
    Type: stringFormat: date-time

    Time the Verification Session was created.

  • updated
    Type: stringFormat: date-time

    Time the Verification Session was last updated.

  • object
    enum
    const:  
    verification_session
    required

    Identifies the resource carried by this event.

  • status
    Type: string

    Verification Session status at the time of the event.

  • type
    Type: string | nullenum
    values
    • document

      Verification using an identity document.

    • id_number

      Verification using an identity number.

  • account_id
    Type: string

    Account associated with the Verification Session.

  • livemode
    Type: boolean

    Whether the resource belongs to live mode or test mode.

  • url
    Type: string

    URL for completing verification. Empty after redaction.

  • return_url
    Type: string | null

    URL to return to after verification.

  • verification_flow
    Type: string | null

    Verification flow used by this session.

  • related_person
    Type: object | null

    Person associated with the Verification Session.

    Properties: 2
  • metadata

    Metadata attached to the resource.

    Metadata attached to the resource.

    • propertyName
      additionalPropertyType: string