Skip to main content

Set Default Signer Group


Introduction​

This resource sets (or removes) a signer group as the default group of the registration analysis. Only one group can be marked as default at a time — when a group is marked as default, the previously default group is automatically unmarked.

The default group is the one used by default when generating documents for signature, if the analysis is submitted without explicitly providing an external_signer_group_key.

Available on
ProfileHostRequired permission
Consultantconsultant-apiGranted by the integration team

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/signer_group/{external_signer_group_key}/default
METHOD
PUT
STATUS
202

Request body​

Request Body
{
"value": true
}

Body params​

FieldTypeDescriptionRequired
valuebooleantrue to set this group as defaultYes

Response​

202 Accepted. The updated representation of the group is returned in the body.

Errors​

StatusCodeWhen it happens
400IVR000185The analysis has already been closed (approved, rejected, completed or canceled)
404IVR000182Signer group not found

Authentication, permission and host errors: see API Errors.