API ReferenceConnectors
Request Connector Access
Submit a manual-enrollment intake for a connector that requires provider-side business verification
Only for connectors whose auth_type is request_access (Truecaller, Google Verified Calls, Google Verified SMS) — these require provider-side business verification before they can be used, so this submits an intake form rather than connecting immediately. Submitting again while a request is already pending for this provider is a no-op.
Path Parameters
provider*Provider
Header Parameters
X-API-Key?string|null
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/api/v1/connectors/string/request-access" \ -H "Content-Type: application/json" \ -d '{ "values": { "property1": "string", "property2": "string" } }'{ "provider": "string", "display_name": "string", "description": "string", "category": "string", "docs_url": "string", "auth_type": "string", "oauth_provider": "string", "oauth_app_configured": false, "oauth_redirect_uri": "string", "oauth_extra_fields": [], "action_count": 0, "connect_fields": [], "connected": true, "credential_uuid": "string", "request_fields": [], "access_requested": false}