Phone Authentication with editable phone number and country code with PropertyMetadata ?

  • 29 March 2024
  • 1 reply



We are DocuSign C# SDK.

We are configuring recipient identity verification through phone authentication with IdentityVerification < Signers < Recipient < EnvelopeDefinition 

We have 

IdentityVerification = new RecipientIdentityVerification
                WorkflowId = _signatureSettings.PhoneAuthenticationWorkflowId,
                InputOptions = new List<RecipientIdentityInputOption>
                    new RecipientIdentityInputOption
                        Name = "phone_number_list",
                        ValueType = "PhoneNumberList",
                        PhoneNumberList = new List<RecipientIdentityPhoneNumber>
                            new RecipientIdentityPhoneNumber
                                Number = signer.Phone.Number,
                                CountryCode = signer.Phone.CountryCode,

How can we permit the signer to provide an other phone number when they are in the phone authentication process ? 

I see that in RecipientIdentityPhoneNumber there is “NumberMetadata” & “CountryCodeMetadata” with those descriptions : ”Metadata that indicates if the `number` property is editable.” & “Metadata that indicates if the `countryCode` property is editable.”

The expected type is “PropertyMetadata” with List<string> Options & string Rights.

How can we use it so that signers can edit their phone number when authenticating?


Thank you

1 reply


Hello Joel Lopes,

As you already did, the recipient phone number should be passed on the EnvelopeDefinition. Although its important to mention that only the sender, not the signer, can modify this information.
Once the phone number is set, it can still be changed, but for doing this, it will require a new email to be sent with the updated information and the original email link will be invalidated.
If you need to change the phone number, the sender needs to do a PUT request in order to update/correct recipient information to the envelope before sending it.
You can refer to this blog post to get more details on recipient authentication.