Skip to content
GridRouterhome

Search

Search providers, capabilities and pages

Docs
API referenceKeys and access

Test a vendor key before saving it

POST
/v1/credentials/{provider}/verify

Call the provider's free, read-only test endpoint with a key that is not stored yet. Nothing is saved; the key is used for this one call. Never charged; the call is logged.

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

provider*string
Match^[a-z0-9]+(-[a-z0-9]+)*$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/credentials/string/verify" \  -H "Content-Type: application/json" \  -d '{    "fields": {      "property1": "string",      "property2": "string"    }  }'
{  "object": "credential_test",  "provider": "string",  "slot": "primary",  "ok": true,  "endpoint_id": "string",  "call_id": "string",  "latency_ms": 0,  "message": "string",  "data": {    "property1": null,    "property2": null  }}