verification-providers

Update verification provider

Patches a verification provider's config: omitted fields are unchanged, a supplied zero value clears the field. name and tenant are immutable. The WHOLE resulting config is re-validated with the create rules, so an update that leaves a dangling group reference or an unmapped allowed action is refused. Supplying auth_key seals it (and removes a legacy plaintext metadata.auth_key); "" clears it. Platform-admin only. Unknown body keys are 400.

put/admin/verification-providers/{id}

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/admin/verification-providers/{id}
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Path parameters

idstring required

provider row id

Request body

action_group_mapobject

action -> group SLUG. Every key must be in allowed_actions; every value a live group in the tenant.

allowed_actionsstring[]

Actions this provider may serve. Every entry must route to a group (its action_group_map entry or target_group_name). Empty permits every action.

api_endpointstring

gRPC SessionProvider address, e.g. enforcer-cybrid:50054. Required on create.

auth_keystring

WRITE-ONLY shared secret sent to the SessionProvider (x-verifier-key). Sealed at rest; never returned. "" clears it.

idempotency_enabledboolean

Reuse a pending session instead of minting a new one.

insecureboolean

Dial plaintext gRPC (cluster-internal); TLS otherwise.

is_asyncboolean

Provider completes out-of-band via the verification.callback event.

sensitive_fieldsstring[]

Response fields returned to the client but never persisted.

session_ttlinteger

Session lifetime in seconds.

target_group_namestring

Default group SLUG granted on a pass. Must be a live group in the tenant.

Example request

{
  "api_endpoint": "enforcer-cybrid:50054",
  "target_group_name": "kyc_users"
}

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.