Create API Key Connection

View as Markdown

Validates credentials and creates a ConnectedAccount for a non-OAuth platform.

The credential fields vary per platform — use GET /accounts/connect/{platform} to discover required fields.

Returns 409 Conflict if an active connection already exists for this tenant+platform. Returns 422 if credentials fail validation against the platform API.

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
external_account_idstringRequired

Optional: External merchant/account ID from the platform - max 255 chars - “merchant_123”

credentials[api_key]stringRequired

Required (NMI): API key for authentication - string - “sk_test_abc123”

credentials[public_key]stringRequired

Optional (NMI): Public key for frontend card tokenization - string - “pk_test_xyz789”

credentials[environment]stringRequired

Required (NMI): Environment to connect to - sandbox|production - “sandbox”

credentials[webhook_signing_key]stringRequired

Optional (NMI): Webhook signing key for signature verification - string

Response

Successful response