Skip to main content
Question

SOAP API RequestStatus does not return RecipientId

  • December 20, 2024
  • 2 replies
  • 21 views

Forum|alt.badge.img+1

I have use case where I need to uniquely identify a recipient. With REST API, it works fine. However, with SOAP, response does not return RecipientId as documented.

https://demo.docusign.net/api/3.0/dsapi.asmx?op=RequestStatus

<RequestStatusResponse xmlns="http://www.docusign.net/API/3.0">      <RequestStatusResult>        <RecipientStatuses>          <RecipientStatus>            <Type>Signer or Agent or Editor or Intermediary or CarbonCopy or CertifiedDelivery or InPersonSigner or SigningHost</Type>            <Email>string</Email>            <UserName>string</UserName>            <RoutingOrder>unsignedShort</RoutingOrder>            <Sent>dateTime</Sent>            <Delivered>dateTime</Delivered>            <Signed>dateTime</Signed>            <Declined>dateTime</Declined>            <DeclineReason>string</DeclineReason>            <AutoRespondedReason>string</AutoRespondedReason>            <Status>Created or Sent or Delivered or Signed or Declined or Completed or FaxPending or AutoResponded</Status>            <RecipientIPAddress>string</RecipientIPAddress>            <ClientUserId>string</ClientUserId>            <AutoNavigation>boolean</AutoNavigation>            <IDCheckInformation xsi:nil="true" />            <RecipientAuthenticationStatus xsi:nil="true" />            <CustomFields xsi:nil="true" />            <TabStatuses xsi:nil="true" />            <RecipientAttachment xsi:nil="true" />            <AccountStatus>string</AccountStatus>            <EsignAgreementInformation xsi:nil="true" />            <FormData xsi:nil="true" />            <RecipientId>string</RecipientId>            <DeliveryMethod>Email or Fax</DeliveryMethod>            <FaxNumber>string</FaxNumber>          </RecipientStatus>

Is this a bug where RecipientId is not being returned in RequestStatusResponse?

Thanks in advance for your feedback

2 replies

JohnSantos
Valued Contributor
Forum|alt.badge.img+18
  • Valued Contributor
  • 975 replies
  • December 20, 2024

@meilinglam 

In most cases, a RecipientId should appear in the SOAP RequestStatus response if it was assigned when the envelope was created. If you are not seeing a RecipientId, it may be due to how the recipient was created, the type of recipient, or a quirk in how the SOAP API returns data. It’s not necessarily a confirmed “bug,” but rather an inconsistency or a conditional field return behavior.


Forum|alt.badge.img+4

Hi ​@meilinglam,

The issue where the RecipientId is not returned in the RequestStatusResponse could be due to the following:

  1. Envelope Status: The availability of RecipientId may depend on the envelope's current status. Please ensure the envelope is active and contains valid recipient information.

  2. SOAP API Logs: It might also be related to the specific details or configurations of your SOAP request. Reviewing the request and response logs can help identify any discrepancies.