Skip to main content

Create a Validation Invite

POST 
/v1/validation-invites

Create a Validation Invite

Request​

Body

required

    redirectUrl url

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

    Possible values: <= 255 characters

    Example: https://example.com/finish
    metadata object

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

    language string

    Valid RFC 5646 language code

    Example: en-GB
    hostedConfigId string

    Hosted configuration id

    Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses​

Successfully created a Validation Invite

Schema

    data

    object

    id string
    Example: validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    status string

    Possible values: [open, expired, complete]

    Example: open
    metadata objectnullable

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

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

    Defaults to en-GB

    Example: en-GB
    redirectUrl url

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

    Example: https://example.com/finish
    url url

    Dynamic Hosted form URL for the validation invite

    Example: https://validation.poweredbypercent.com/validate/validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx?token=asasjhd
    createdAt date-time
    Example: 2020-10-13T17:46:54.000Z
    expiresAt date-time
    Example: 2020-10-20T17:46:54.000Z
    object string
    Example: validation_invite
Loading...