Verdocs - Update Recipient

Path Parameters

envelope_id*string

The envelope to operate on.

Formatuuid

role_name*string

The role name to update.

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

action?string

Trigger a reminder, or fully reset the recipient

Value in"remind" | "reset"

first_name?string

Update the recipient's first name.

last_name?string

Update the recipient's last name.

email?string

Update the recipient's email address.

message?string

Update the recipient's invite message.

phone?string

Update the recipient's phone number.

passcode?string

If passcode authentication is used, the recipient's address to prefill. May only be changed if the recipient has not already completed passcode-based auth.

address?string

If KBA-based authentication is used, the recipient's address to prefill. May only be changed if the recipient has not already completed KBA-based auth.

city?string

If KBA-based authentication is used, the recipient's city to prefill. May only be changed if the recipient has not already completed KBA-based auth.

state?string

If KBA-based authentication is used, the recipient's state to prefill. May only be changed if the recipient has not already completed KBA-based auth.

zip?string

If KBA-based authentication is used, the recipient's zip code to prefill. May only be changed if the recipient has not already completed KBA-based auth.

dob?string

If KBA-based authentication is used, the recipient's date of birth to prefill. May only be changed if the recipient has not already completed KBA-based auth.

ssn_last_4?string

If KBA-based authentication is used, the recipient's SSN-last-4 to prefill. May only be changed if the recipient has not already completed KBA-based auth.

Response Body

`application/json`

curl -X PATCH "https://api.verdocs.com/envelopes/497f6eca-6276-4993-bfeb-53cbbbba6f08/recipients/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "address": "string",
  "auth_method_states": "string",
  "auth_methods": "string",
  "auth_step": "string",
  "city": "string",
  "disclosures": "string",
  "disclosures_accepted_at": "string",
  "dob": "string",
  "full_name": "string",
  "id": "string",
  "in_app_key": "string",
  "kba_questions": "string",
  "order": 0,
  "passcode": "string",
  "phone": "string",
  "sequence": 0,
  "ssn_last_4": "string",
  "state": "string",
  "zip": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

Update Recipient

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

406application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`