patch
https://api.sb.spidrsrv.com/v1/entity//cipStatus
Use PATCH on /cipStatus to override an entity's CIP (Customer Identification Program) status. This endpoint is an override, not a setter: it only changes a status that your program's onboarding flow has already decided.
⚠️ Warning: Directly editing an entity's CIP status will override the CIP status set by the program. Only call this endpoint for an entity that already has a decided CIP status.
Preconditions
- The entity must have a decided CIP status of
passorfail. Ifcip.statusis absent orpend, the request will return400because there is nothing to override yet. - When setting the status to
pass, every non-archived beneficial owner withcipRequiredset to true must already have a CIP status ofpass, otherwise the request is rejected.
📘 Note: An entity's CIP status is produced by completing the business's KYB onboarding flow. Use this endpoint only to override an already-decided status, not to force an initial decision.
Error Codes
The codes below are not listed in evaluation order.
| Error Code | HTTP Status | Description |
|---|---|---|
CIP_NOT_YET_DETERMINED | 400 | No CIP decision has been reached yet (the CIP status is absent or pend), so there is nothing to override. |
BENEFICIAL_OWNERS_CIP_STATUS_NOT_PASS | 400 | One or more required beneficial owners do not have a CIP status of pass, so the entity cannot be set to pass. |
USER_NOTHING_TO_MODIFY | 400 | The requested CIP status already matches the entity's current status; there is nothing to update. |
ENTITY_NOT_FOUND | 404 | No active entity with this id exists for your program. |