/guestLink/createGuestLink/

This endpoint creates a link that allows a guest to log in and upload one application.

The link remains valid until an application is submitted using it, or until it expires. The expiry period is configured against a customer account and is typically seven days.

Request

POST {{server}}/VPE/guestLink/createGuestLink/
Content-Type: application/json
Tid-Api-Key: xxx-xxx-xx
{
    "SessionId": "...",
    "DeviceId": "...",
    "Email": "guest@domain.co.uk",
    "Name": "Guest Name",
    "BranchId": "...",
    "ApplicationFlexibleFieldValues": [
        {
            "FlexibleFieldVersionId": "...",
            "FieldValueString": "Software Development and IT Department"
        },
        ...
    ],
    "EmailSubjectOverride": null,
    "EmailContentOverride": null,
    "ContainerEventCallbackUrl": "https://www.my-company.co.uk/web-hooks/container-event-callback/",
    "ContainerEventCallbackHeaders"::[
        {
            "Header":"Authorization",
            "Value":"..."
        }
    ],
    "ClientApplicationReference": "MyReference",
    "DigitalIdentificationScheme":1
}

CreateGuestLinkRequest.Email

= Email

The email address of the guest. The invitation email containing the login link is sent to this address.

CreateGuestLinkRequest.Name

= Name

The name of the guest. This name is used in the invitation email and is also stored in the application’s guest name flexible field.

CreateGuestLinkRequest.BranchId

= BranchId

The unique identifier of the branch to assign this guest application to. If this is not supplied, the application is assigned to the branch of the session account.

Note

To obtain a list of branches use /dataAccess/queryBranchesX/.

CreateGuestLinkRequest.ApplicationFlexibleFieldValues

= ApplicationFlexibleFieldValues

A list of application-level custom fields to attach to the guest scan.

{
     "ApplicationFlexibleFieldValues": [
         {
             "FlexibleFieldVersionId": "...",
             "FieldValueString": "Software Development and IT Department"
         }
     ]
}

Property	Description
ApplicationFlexibleFieldValue.FlexibleFieldVersionId	Flexible field identifier.
ApplicationFlexibleFieldValue.FieldValueString	Flexible field value for string values.
ApplicationFlexibleFieldValue.FieldValueInt	Flexible field value for integer values.
ApplicationFlexibleFieldValue.FieldValueDate	Flexible field values for date values.
ApplicationFlexibleFieldValue.FieldValueDecimal	Flexible field values for decimal values.

See also

ApplicationFlexibleFieldValue for more information about application flexible field values.

CreateGuestLinkRequest.SendEmail

= SendEmail

A flag to determine whether an email should be sent to the guest. The default value if this is omitted from the request is true. If this is set to false, the link will be included in the response and it is the caller’s responsibility to pass this onto the guest.

CreateGuestLinkRequest.EmailSubjectOverride

= EmailSubjectOverride

An optional property that can be used to override the default Subject used in the email sent to the guest. To use the default Subject when generating the email, omit this from the request.

CreateGuestLinkRequest.EmailContentOverride

= EmailContentOverride

An optional property that can be used to override the default email body used in the email sent to the guest. To use the default email body when generating the email, omit this from the request.

Note

Only the first portion of the email body can be modified, the second portion is fixed. This value must be supplied as markdown; it is converted to HTML when sending the email.

CreateGuestLinkRequest.ContainerEventCallbackUrl

= ContainerEventCallbackUrl

An optional property which can be used to link “guest link” to specified callback url.

Note

This will override static address against your account.

CreateGuestLinkRequest.ContainerEventCallbackHeaders

= ContainerEventCallbackHeaders

An optional property containing a list of headers and values used with callbacks.

{
     "ContainerEventCallbackHeaders": [
         {
             "Header": "Authorization",
             "Value": "..."
         }
     ]
}

Property	Description
ContainerEventCallbackHeaders.Header	Header property used with callbacks, following properties allowed: (Authorization).
ContainerEventCallbackHeaders.Value	Value of Header property.

CreateGuestLinkRequest.ClientApplicationReference

= ClientApplicationReference

An optional string that can be passed through, that allows for calling clients to add identifying information. This may be useful for the adding of context mapping, or linking your object ID’s to ours. This value will be included in request payload sent to your webhook.

CreateGuestLinkRequest.DigitalIdentificationScheme

= DigitalIdentificationScheme

An optional property a digital identification scheme of the guest link.

See also

DigitalIdentificationScheme for more information about the digital identification scheme.

Response

{
     ...
     "Success": true,
     "Message": "Operation executed successfully.",
}

CreateGuestLinkResponse.EmailSubject

= EmailSubject

The default email subject that will be used in the email sent to the guest. This is only included if you set operationMode = 1.

CreateGuestLinkResponse.EmailContent

= EmailContent

The default email body that will be used in the email sent to the guest. Note that this is not the entire body; only the overrideable first portion. This is only included if you set operationMode = 1.

CreateGuestLinkResponse.LinkUrl

= LinkUrl

The link that the guest should use to access the TrustID web client to upload their application. This is only included if you set operationMode = 0 and sendEmail = false.