Skip to main content
Weavr API
Corporates

Submit the KYB account-usage profile for a corporate

POST/corporates/{corporateId}/kyb/profile

Use this when you already know how a corporate intends to use its account and want that answered ahead of verification, so the corporate doesn't have to fill it in again.

It records the account-usage profile for the corporate identified by the corporateId path parameter: where funds come from, where they go, expected monthly volumes and values, and whether collections, payouts, and cards are in use. Every field is optional.

Calling it more than once

Each call updates the profile field by field. A field sent with a new value replaces the earlier answer; a field left out or sent empty keeps it, so an answer can't be cleared. Sending the same request again changes nothing. The simplest approach is to send the complete profile each time.

Timing

This only works before verification starts. Once the corporate has begun its KYB journey the submission is rejected with KYB_ALREADY_STARTED, so submit what you hold before calling Start KYB for a corporate. A MANAGED_ONBOARDING_PENDING response from Start KYB doesn't close this window. The root user doesn't need to have verified their email yet. NOT_SUPPORTED means the corporate's profile isn't configured to accept pre-populated KYB data.

Read Corporate due diligence and KYB for the full verification flow.

Request

Available on
SandboxProduction

Path parameters

Request body

*
application/json

Account-usage profile submitted to pre-populate a corporate's KYB.

{}
CorporateKybProfileSubmissionCorporateKybProfileSubmission · object · 1 field

Responses

201Created

Profile accepted