Create a Validation Invite

POST 
/v1/validation-invites

Create a Validation Invite

Request

application/json

Body

required

redirectUrlurl
Url that the hosted form redirects to after the flow is completed
Possible values: <= 255 characters
Example: https://example.com/finish
metadataobject

You can use this parameter to attach key-value data to a Validation Invite

languagestring
Valid RFC 5646 language code
Example: en-GB
hostedConfigIdstring
Hosted configuration id
Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

200

Successfully created a Validation Invite

application/json

Schema

Schema

data

object

idstring

Example: validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

statusstring

Possible values: [open, expired, complete]

Example: open

metadataobjectnullable

Key-value data that you can attach to an object.

Example: {"key1":"value1","key2":"value2"}

languagestring

Defaults to en-GB

Example: en-GB

redirectUrlurl

Url that the hosted form redirects to after the flow is completed

Example: https://example.com/finish

urlurl

Dynamic Hosted form URL for the validation invite

Example: https://validation.poweredbypercent.com/validate/validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx?token=asasjhd

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

expiresAtdate-time

Example: 2020-10-20T17:46:54.000Z
objectstring
Example: validation_invite

Example (from schema)

{
  "data": {
    "id": "validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": "open",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "language": "en-GB",
    "redirectUrl": "https://example.com/finish",
    "url": "https://validation.poweredbypercent.com/validate/validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx?token=asasjhd",
    "createdAt": "2020-10-13T17:46:54.000Z",
    "expiresAt": "2020-10-20T17:46:54.000Z"
  },
  "object": "validation_invite"
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

400 Incorrect Parameters

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}