Skip to main content
GET
Test Connection Credentials by Connection ID

Authorizations

X-API-KEY
string
header
required

Path Parameters

organization_id
string<uuid>
required
connection_id
string<uuid>
required

Response

Successful Response

is_valid
boolean
required

Whether the credentials authenticated against the vendor. A test that reaches the vendor and is rejected is false, not an error.

message
string | null

Why the test failed, in the vendor's words where they gave a reason. Null when it succeeded.