Identra Docs
Reference / Settings

perform a real test send through the configured provider; flips it to `verified` on success.

POST /v1/applications/{id}/providers/messaging/verify
Secret API key operationId: verify_messaging

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

  • id string<uuid> required

    Application id

Request body · required

  • channel string required
  • to string

    Where to send the test message (the dashboard passes the signed-in member's email).

Responses

200 Verification result
{
  "data": {
    "detail": "string",
    "status": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}
422 Not configured / unsupported

Request

curl -X POST "http://localhost:8080/v1/applications/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/providers/messaging/verify" \
  -H "Content-Type: application/json" \
  -d '{
  "channel": "string",
  "to": "string"
}'

Try it

live request
POST http://localhost:8080/v1/applications/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/providers/messaging/verify

Path parameters

Request body

application/json