Auto-tagging (recipient)

AI Tools

You can add a tag to your template document using our auto tagging feature by inserting an anchor into your document. An anchor is made of:

A Role
Recipient number
Tag Type
Required/Optional

Anchor Type	Example	Description
Role	Signer `(S)`	Role of the recipient
Recipient number	x`(1 to 30)`	Number of recipients. This must be a number from 1 to 30.
Tag Type	Signature `(S)`	Type of field. See above for more details.
Required / Optional	Required `(R)` or Optional `(O)`	If you require the recipient to complete this transaction in order to sign the document.
Header tag	\|AT\|	Place this on the first page of your document to signify that the document contains auto tags.

An example of an anchor is:

To use the auto tagging feature you will first have to enable this in your options object. You will need to set the Industry Type based on the Signer Roles you wish to use. Please see the table below.

Hint The tags property in your recipients object should be empty.

{ "name": "envelope name", { // Options object "name": "envelope name", "autotagging": "GENERAL", //Industry Type "emails": { "invitation": { "body": { "message": "Please sign this document" } } }, "recipients": [ { "name": "User 1", "email": "user1@test.com", "role": "Signer 1", //This must match the tag anchor on your document "auth_type": "no-auth", "sign_group": 1, "tags": [] //This should be present but empty },

A list of the roles the Yoti Sign API offers:

Roles	Tag	Industry Type
Signer	S	GENERAL
Tenant	T	REAL_ESTATE
Landlord	L	REAL_ESTATE
Agent	A	REAL_ESTATE
Guarantor	G	REAL_ESTATE
Contractor	C	REAL_ESTATE

A list of the tag types the Yoti Sign API offers:

Tag Types	Tag	Example
Signature	S	S1SR
Text Field	T	S1TR
Check Box	CB	S1CBR
Date Signed	DS	S1DSR
Radio Group	RG[X]*	S1RG1R
Attachment	A	S1AR
Initials	IN	S1INR

The [X] relates to the number of radio group boxes that are required.

There are also metadata tag types that can be configured:

Metadata Tag Type	MetaTag	Example
name	nm	S1SR{"nm":"customTag"}
placeholder	ph	S1TR{"ph":"my placeholder value"}
pre-filled value	pf	S1TR{"pf":"my pre-filled value"}

Note the metadata tag types can only be used for the Text field(TR) tag type.

Hint the placeholder and pre-filled values can only be assigned to text field tags.

Good to know

Make sure that your tags are formatted correctly by viewing the auto tagging matrix.

View matrix

Last updated on

Was this page helpful?