ErrorResponse
object>= 1 characters
Example:{"code":"VALIDATION_ERROR","description":"Validation failed for field '$.fieldName'","details":"The request contains an unrecognized property. Only documented fields are allowed.","timestamp":"2024-01-15T10:30:00.000Z"}
Show Child Parameters
EsignatureResponse
objectTrue when signers were retrieved successfully.
User-safe message; populated when success is false.
DocuSign recipients for the transaction, ordered by signing sequence.
Example:{"recipientId":"11306862","signerName":"EE EE","signerEntityRole":"PrimaryOwner","signerEmail":"anannya.gupta@everglades.com","signerSequence":"1","signerAccessCode":[],"signerAuthMethod":["Phone","SMS"],"signerCountryCode":"1","signerPhoneNo":"8650827071"}
Show Child Parameters
EsignatureSigner
objectDocuSign recipient ID from the recipient proc.
Display name shown in the signer grid.
Entity role (for example PrimaryOwner, AgentOfRecord).
Signer email; may be empty for some roles.
Signing order when routing is sequential.
Access codes when configured; empty array when none.
Array of auth method labels (for example Phone, SMS).
Country calling code (default 1 for US).
Phone digits only; stored without dashes in proc.
EsignatureSignerStatus
objectDocuSign recipient sequence (RecipientID from proc).
Display name in the signer grid.
Delivered | Needs to Sign | Needs to View | Waiting for Other Signer(s) | Completed (Signed).
Signer email; may be read-only for AYCO.
When this recipient last acted or status changed, as returned by upstream (format varies; often empty until an action occurs).
Phone, SMS, or None.
Country calling code (default 1 for US; up to ~3 characters).
Digits only (no dashes); typically 10 digits for US display.
EsignatureSignerStatusResponse
objectTrue when signer status rows were retrieved successfully.
Per-recipient DocuSign status and contact details for the transaction.
Example:{"recipientId":"11306862","signerName":"EE EE1","signerStatus":"Needs to Sign","signerEmail":"anannya.gupta@everglades.com","dateOfAction":"2026-01-12T14:22:00","signerAuthMethod":"Phone","signerCountryCode":"1","signerPhoneNo":"8650827071"}