Create a group
Create a group — a multi-party deal/matter workspace. For real
estate and buyer’s agents this is typically one group per
property: pass the property address as name and your CRM’s
listing/deal id as reference, and call this endpoint from your
CRM’s “property created” webhook.
Provide either a templateId (see GET /group-templates) —
the template’s roles become the group’s party slots and any
folded-in workflow is started — or explicit parties, each
optionally pre-attached to a customer by Instant Compliance id
(customerId) or by your own id (customerExternalId, as
supplied on POST /customers). Not both.
Duplicate guard
- If
referenceis supplied and an active group with the same reference already exists in your organisation, that group is returned with 200 OK and nothing is created — webhook retries and re-syncs are safe by construction. - Otherwise the group is created and returned with 201 Created.
Include an Idempotency-Key header to also make network retries
safe for 24 hours.
Requires the groups:write scope and the Groups feature enabled
for your organisation (403 feature_disabled otherwise).
name and your listing/deal id as reference.
Template or explicit parties
Provide either:templateId— the template’s roles become the group’s party slots and any folded-in workflow is started. Discover ids with List group templates.parties— explicit role slots, each optionally pre-attached to a customer by Instant Compliance UUID (customerId) or by your own id (customerExternalId, as supplied onPOST /customers).
POST /customers and use explicit parties instead).
Duplicate guard
Whenreference is supplied and an active group with the same
reference already exists, that group is returned with 200 OK and
nothing is created. This makes CRM webhook retries and full re-syncs
safe by construction. New groups return 201 Created.
For transport-level retry safety you can additionally send an
Idempotency-Key header (24-hour replay window).
Requirements
- Scope:
groups:write - The Groups feature must be enabled for your organisation —
otherwise the request fails with
403 feature_disabled.
After creation
The response’surl deep-links to the group workspace in the Instant
Compliance app, where your compliance team sees the parties, requests
documents, and runs verification. Nothing is charged and no
verification is triggered by this call.Authorizations
Bearer API key issued from Settings → Developers in your
Instant Compliance organisation. Format: ic_live_….
Headers
Caller-supplied unique key for safe retries. Repeat the same key within 24 hours and we replay the original response instead of repeating the side effect. Reusing the key with a different request body returns 409 idempotency_conflict.
255Body
Display name — e.g. the property address.
255Your stable deal/listing id. Also the duplicate guard — an existing active group with the same reference is returned instead of creating a twin.
255Group template to instantiate (see GET /group-templates).
Mutually exclusive with parties.
50Response
An active group with this reference already exists — returned unchanged.
ACTIVE, ON_HOLD, COMPLETE, ARCHIVED Deep link to the group workspace in the Instant Compliance app.

