Skip to content

Get recipient settings

Request

Returns the recipient configuration for the specified organization.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

GET
/api/v1/organizations/{organizationId}/settings/recipient
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/settings/recipient' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
sendCompletedFileToAllRecipientsbooleanrequired

Whether the completed file is sent to all recipients.

warnIfRecipientsHaveNoFieldsbooleanrequired

Whether a warning is shown when some recipients have no fields.

authenticationsobject(RecipientAuthenticationSettings)required

The organization's recipient authentication settings.

recipientDelegationstring(RecipientDelegation)required

The recipient delegation policies supported by the settings/recipient endpoint.

Enum:"notAllowed""allowedDisabled""allowedEnabled"
mandatoryAuthenticationMandatoryAuthenticationNone (object) or MandatoryAuthenticationAny (object) or MandatoryAuthenticationAccessCode (object) or MandatoryAuthenticationOneTimePassword (object) or MandatoryAuthenticationOAuth (object)required
One of:

No mandatory authentication method is enforced.

Response
{ "sendCompletedFileToAllRecipients": true, "warnIfRecipientsHaveNoFields": true, "authentications": { "accessCode": true, "oneTimePassword": { … } }, "recipientDelegation": "allowedEnabled", "mandatoryAuthentication": { "authentication": "None" } }