Create a VerificationSession

​

After the VerificationSession is created send your users to the session’s url.

Body·VerificationSession Create Request
required
application/json

Request to create a VerificationSession

  • Type: object · VerificationSession Create Request

    Request to create a VerificationSession

    • metadata

      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.

      • propertyName
        Type: string
    • related_person
      Type: object
    • return_url
      Type: string

      The URL that the user will be redirected to upon completing the verification flow.

    • type
      Type: string | nullenum
      values
      • document
      • id_number
    • verification_flow
      Type: string | null
Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v1/identity/verification_sessions
curl https://api.paypercut.io/v1/identity/verification_sessions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "verification_flow": null,
  "type": "document",
  "related_person": {
    "account": "01K755J9SV2364REVHB915Z2FW",
    "person": "01K755J9SV2364REVHB915Z2FW"
  },
  "metadata": {
    "additionalProperty": ""
  },
  "return_url": ""
}'

{
  "url": "string"
}

Successful response