ID Verification

ID Verification

Your account may be required to complete ID verification in some cases (e.g. receiving affiliate payout). The ID verification can only be initiated if an account reached to this condition (e.g. minimum payout amount).

Webshare uses Stripe Identity (opens in a new tab) for ID Verification. You must use the Stripe JS library (opens in a new tab) to complete the ID verification within the application. No ID documents are sent to the Webshare servers.

The ID verification object

You can use the API to retrieve information about the ongoing ID verification

The verification object

  "id": 1,
  "state": "not-required",
  "client_secret": null,
  "verification_failure_times": 0,
  "max_verification_failure_times": 0,
  "created_at": "2019-05-09T23:34:00.095501-07:00",
  "updated_at": "2019-05-09T23:34:00.095501-07:00",
  "verified_at": null

Verification object

idUnique identifier of this instance.
stateState of the current ID verifiation. The verification states are listed below in further detail.
client_secretClient secret to be used with the Stripe JS API (opens in a new tab). May be null if the verification is not in the pending state.
verification_failure_timesNumber of times the ID verification has failed.
max_verification_failure_timesMaximum number of times an ID verification can fail before the user cannot initiate a new ID verification. If set to 2, it means the user can try to verify their account 2 times. After the second failure, they won't be able to initiate ID verification any longer.
created_atThe original registration date. ISO 8601 (opens in a new tab) format.
updated_atThe last time the verification object updated. ISO 8601 (opens in a new tab) format.
verified_atTimestamp when the account has successfully completed the ID verification. ISO 8601 (opens in a new tab) format. May be null.

Verification state

not-requiredThe user is not required to complete ID verification. They may be required to complete ID verification when their payout threshold is met.
requestedThe user should start a verification. In this state, client-secret is null.
pendingThe user did initiate an ID verification. The user did not complete the ID verification yet on Stripe JS API. client-secret is set.
processingThe user completed the ID verification. We are now processing the validity of the ID verification. client-secret is null.
failedThe user has failed ID verification. The user may restart verification if verification_failure_times is less than max_verification_failure_times.
verifiedThe user has completed ID verification successfully.