Only the email address of the participant is mandatory when configuring your transaction. However, you can define the participant name that will be used in the transaction.
You need to pass two arguments to specify the participant’s name in a transaction:
-
full_name
: allows you to define the participant’s full name. -
full_name_type
: allows you to define the type of the participant’s full name, among:-
suggestion
: you give Universign or the signer the authorization to use a different full name that might be more appropriate. This means the participant will be allowed to modify his/her name on the signature page. It also means that if the participant already has a certificate linked to the same email under a different name (spouse name for example), Universign will use the name of the certificate instead of the name you entered in the transaction. -
prerequisite
: you do not give Universign nor the signer the authorization to use a different full name than the one you entered. This means that the participant will not be allowed to modify his/her name on the signature page. It also means that if the participant already has a certificate linked to the same email under a different name (spouse name for example), Universign will not use the name of the certificate. If the requested level of the signature waslevel_1
, we will not upgrade the signature to advanced, and if the requested level waslevel_2
, we will have to create another certificate, and the participant will have to undergo a new identity verification.
-
Set name as a suggestion
Send a request to POST /v1/transactions/{transaction_id}/participants
and pass the participant email
, the full name in the the full_name
argument as well as suggestion
in the full_name_type
argument:
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d email=john@company.com \
-d full_name=john \
-d full_name_type=suggestion
Set name as a prerequisite
Send a request to POST /v1/transactions/{transaction_id}/participants
and pass the participant email
, the full name in the the full_name
argument as well as prerequisite
in the full_name_type
argument:
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d email=john@company.com \
-d full_name=john \
-d full_name_type=prerequisite
Note that if you don’t pass a full_name_type
, default value is suggestion
.