Skip to content

Replace the registered embed origins for a programme

POST/v1/kyc/capture-origins

Requires an API client bearer token.

Replaces the whole embed-origin allowlist for a programme with the given list (max 10, each a canonical https origin — http allowed for localhost only). An empty list is the not-embeddable default posture, not an error. Requires Idempotency-Key; an identical retry returns the SAME stored list.

Parameters

Header parameters

NameRequiredDescription
Idempotency-Keyrequired

Client-chosen. An identical retry with the same key returns the stored response; reusing the key with a different payload returns 409.

Request body

programme_idstringrequired
originsarray of stringrequired

Example

curl -X POST https://api.rigid.fi/v1/kyc/capture-origins \
  -H "Authorization: Bearer $RIGID_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "programme_id": "string",
  "origins": [
    "string"
  ]
}'

Responses

200

The stored embed-origin allowlist for the programme.

programme_idstringrequired
originsarray of stringrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
409

Idempotency-Key reused with a different payload

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring