Create Entity Onboarding (Banking Connectivity)

post

https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Onboard an existing Entity with a Banking Connectivity provider.

Onboarding types

ONE_STEP: Submit all information, compliance declarations, risk assessment, and documents at once. The provider processes immediately.
PREVIOUSLY_ONBOARDED: Generate an internal Yuno onboarding ID without contacting the provider. Use when the entity was already onboarded externally.

For ONE_STEP, include compliance_declaration, risk_assessment, source_of_funds, and documentation. See Documentation types for the full list of supported document types.

Monitor progress via Get Entity Onboarding Status or webhook events. See Onboarding statuses for the full status lifecycle.

Path Params

entity_id

string

required

The id of the entity obtained from Create Entity.

Body Params

account_id

string

required

The unique identifier of the merchant's Yuno account (UUID, 36 characters).

yuno_connection_id

string

required

The pre-configured Banking Connectivity provider connection identifier.

onboarding_type

string

enum

required

The onboarding workflow type. ONE_STEP submits all information at once for provider processing. PREVIOUSLY_ONBOARDED generates an internal Yuno ID without contacting the provider.

Allowed:

compliance_declaration

object

Legal agreements accepted by the entity. Required for ONE_STEP onboarding.

risk_assessment

object

Pre-existing compliance screening results provided by the merchant.

source_of_funds

object

AML/KYC information about the source of funds.

documentation

array of objects

KYC/KYB documents. Each item uses a type discriminator to determine which sub-object to populate. Supported types: IDENTITY_DOCUMENT, PROOF_OF_ADDRESS, BANK_STATEMENT, BUSINESS_DOCUMENT, TAX_INFORMATION, FINANCIAL_DOCUMENT, BIOMETRIC_VERIFICATION, EMPLOYMENT_INFORMATION.

documentation

Headers

x-idempotency-key

string

required

Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts. See authentication for details (UUID).

Responses

200

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Onboarding types

201Created

400Bad Request

404Not Found