Sign in
plaid

Create a CRA servicing subscription

/cra/servicing/subscription/create subscribes a user to CRA report-update webhooks for a given scope.

post/cra/servicing/subscription/create

Request body

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

user_idstring required

A unique user identifier, created by /user/create. Integrations that began using /user/create after December 10, 2025 use this field to identify a user instead of the user_token. For more details, see New User APIs.

scope'PLAID_NETWORK' | 'CLIENT_USER' required

Determines whose items are used. PLAID_NETWORK (default) uses the Plaid Network view of the user's profile. CLIENT_USER uses only the items linked by this client.

cadence'DAILY' | 'null' nullable

The cadence at which products are generated and webhooks are fired. If the Qualify product is requested, cadence must be null or omitted, because Qualify's generation cadence is controlled by Plaid.

webhookstring url

The URL to which the webhook should be sent. If provided, this will override the URL set in the dashboard.

Response

OK

subscription_idstring required

A CRA servicing subscription identifier, in the format cra-sub-<environment>-<uuid>.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes