--- title: "Create Entity Onboarding (Banking Connectivity)" method: POST path: "/banking/entities/{entity_id}/onboardings" tags: ["Entity Onboarding (Banking Connectivity)"] --- # Create Entity Onboarding (Banking Connectivity) `POST /banking/entities/{entity_id}/onboardings` ## Request - Base URL: `https://api-sandbox.y.uno/v1` - URL: `https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings` - Auth: API key in header `PUBLIC-API-KEY` and API key in header `PRIVATE-SECRET-KEY` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `entity_id` string, required ## Headers - `x-idempotency-key` string, required ## Request body - object - `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` 'ONE_STEP' | 'PREVIOUSLY_ONBOARDED', 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. - `compliance_declaration` object: Legal agreements accepted by the entity. Required for `ONE_STEP` onboarding. - `terms_of_service` object: Terms of service acceptance record. - `accepted` boolean, required: Whether the terms of service were accepted. - `version` string: The version of terms accepted. - `accepted_at` string, required: The timestamp when accepted (ISO 8601). - `accepted_ip` string: The IP address from which the terms were accepted. - `privacy_policy` object: Privacy policy acceptance record. - `accepted` boolean, required: Whether the privacy policy was accepted. - `version` string: The version of the privacy policy accepted. - `accepted_at` string, required: The timestamp when accepted (ISO 8601). - `accepted_ip` string: The IP address from which the policy was accepted. - `risk_assessment` object: Pre-existing compliance screening results provided by the merchant. - `assessed_at` string: The timestamp when the assessment was performed (ISO 8601). - `pep_status` object: Politically Exposed Person (PEP) screening results. - `is_pep` boolean: Whether the entity is a PEP. - `pep_level` 'DIRECT' | 'CLOSE_ASSOCIATE' | 'FAMILY_MEMBER' | 'null', nullable: The PEP classification level. - `position` string, nullable: The political role or position, if applicable. - `country` string, nullable: The country of PEP status. - `rca_status` object: Risk Classification Assessment results. - `risk_level` 'LOW' | 'MEDIUM' | 'HIGH': The assessed risk level. - `classified_at` string: The timestamp when classified (ISO 8601). - `assessed_by` string: The name of the assessor or team. - `sanctions_screening` object: Sanctions list screening results. - `appears_on_sanctions_list` boolean: Whether the entity appears on any sanctions list. - `sanctions_list_name` string, nullable: The name of the sanctions list, if matched. - `screened_at` string: The timestamp when the screening was performed (ISO 8601). - `source_of_funds` object: AML/KYC information about the source of funds. - `primary_source` 'EMPLOYMENT_SALARY' | 'BUSINESS_INCOME' | 'INVESTMENTS' | 'RENTAL_INCOME' | 'PENSION' | 'GOVERNMENT_BENEFITS' | 'INHERITANCE' | 'FAMILY_SUPPORT' | 'SAVINGS' | 'LOTTERY_GAMBLING' | 'SALE_OF_ASSETS' | 'CRYPTOCURRENCY' | 'FREELANCE_CONSULTING' | 'OTHER': The primary source of funds. - `secondary_sources` string[]: Additional sources of funds. - `description` string: A detailed explanation of the source of funds. - `estimated_annual_income` object: The estimated annual income. - `amount` number: The annual income amount. - `currency` string: The currency ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)). - `documentation` object[]: 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`. - `type` 'IDENTITY_DOCUMENT' | 'PROOF_OF_ADDRESS' | 'BANK_STATEMENT' | 'BUSINESS_DOCUMENT' | 'TAX_INFORMATION' | 'FINANCIAL_DOCUMENT' | 'BIOMETRIC_VERIFICATION' | 'EMPLOYMENT_INFORMATION', required: The document type discriminator. - `identity_document` object: Identity document details. Provide when `type` is `IDENTITY_DOCUMENT`. - `subtype` 'PASSPORT' | 'DRIVERS_LICENSE' | 'NATIONAL_ID' | 'STATE_ID': The identity document subtype. - `document_number` string: The document number. - `issuing_country` string: The issuing country ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `issuing_state` string: The issuing state or province. - `issued_at` string: The issue date (YYYY-MM-DD). - `expires_at` string: The expiration date (YYYY-MM-DD). - `front_image` object: The front image of the document. - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `back_image` object: The back image of the document. - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `proof_of_address` object: Proof of address details. Provide when `type` is `PROOF_OF_ADDRESS`. - `subtype` 'UTILITY_BILL' | 'BANK_STATEMENT' | 'LEASE_AGREEMENT' | 'MORTGAGE_STATEMENT' | 'TAX_DOCUMENT': The proof of address subtype. - `provider_name` string: The utility or service provider name. - `bill_type` string: The type of bill. - `issued_at` string: The bill issue date (YYYY-MM-DD). - `account_number` string: The account number with the provider. - `verified_address` object: The address shown on the document. - `address_line_1` string - `city` string - `state` string - `zip_code` string - `country` string - `file` object: The document file. - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `bank_statement` object: Bank statement details. Provide when `type` is `BANK_STATEMENT`. - `bank_name` string: The bank name. - `account_number_last_4` string: Last 4 digits of the account number. - `statement_period_start` string: The statement period start date (YYYY-MM-DD). - `statement_period_end` string: The statement period end date (YYYY-MM-DD). - `file` object - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `business_document` object: Business document details. Provide when `type` is `BUSINESS_DOCUMENT`. - `subtype` 'ARTICLES_OF_INCORPORATION' | 'BUSINESS_LICENSE' | 'EIN_CONFIRMATION' | 'OPERATING_AGREEMENT' | 'CERTIFICATE_OF_GOOD_STANDING' - `registration_number` string: The business registration number. - `registered_at` string: The registration date (YYYY-MM-DD). - `issuing_state` string: The issuing state. - `issuing_authority` string: The issuing authority. - `file` object - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `tax_information` object: Tax information details. Provide when `type` is `TAX_INFORMATION`. - `tax_records` object[]: Tax identification records. - `country` string - `tax_id` string - `tax_id_type` 'SSN' | 'EIN' | 'ITIN' | 'VAT' | 'ABN' | 'NIF' | 'TIN' | 'OTHER' - `is_primary` boolean - `tax_document_type` 'W9' | '1099' | 'TAX_RETURN' | 'SSN_CARD' | 'ITIN_LETTER' | 'EIN_CONFIRMATION' | 'VAT_CERTIFICATE': The type of tax document. - `tax_year` string: The tax year. - `issuing_authority` string: The tax authority. - `file` object - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `financial_document` object: Financial document details. Provide when `type` is `FINANCIAL_DOCUMENT`. - `subtype` 'BALANCE_SHEET' | 'PROFIT_LOSS_STATEMENT' | 'CASH_FLOW_STATEMENT' | 'FINANCIAL_AUDIT' - `period_start` string: Period start date (YYYY-MM-DD). - `period_end` string: Period end date (YYYY-MM-DD). - `fiscal_year` string - `audited` boolean: Whether the document has been audited. - `auditor_name` string, nullable: The auditor name, if audited. - `file` object - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `biometric_verification` object: Biometric verification details. Provide when `type` is `BIOMETRIC_VERIFICATION`. - `verification_method` 'FACIAL_RECOGNITION' | 'FINGERPRINT' | 'VOICE' | 'IRIS_SCAN' - `capture_method` 'LIVE_CAPTURE' | 'UPLOADED' - `capture_timestamp` string: When the biometric was captured (ISO 8601). - `liveness_check_passed` boolean: Whether the liveness check passed. - `confidence_score` number: The verification confidence score (0-1). - `verification_provider` string: The biometric verification provider. - `live_image` object - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `reference_image` object - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. - `employment_information` object: Employment information details. Provide when `type` is `EMPLOYMENT_INFORMATION`. - `status` 'EMPLOYED' | 'SELF_EMPLOYED' | 'UNEMPLOYED' | 'RETIRED' | 'STUDENT': The employment status. - `employer_name` string: The employer name. - `occupation` string: The job title or occupation. - `industry` string: The industry sector. - `started_at` string: The employment start date (YYYY-MM-DD). - `annual_income` object: The annual income from this employment. - `amount` number - `currency` string - `verification_document` object: Employment verification document. - `file_name` string - `content_type` string - `content` string: Base64-encoded file content. ## Response `200` ## Other responses - `201`: Created - `400`: Bad Request - `404`: Not Found --- [API](https://skmtc.dev/y/apis/ai-caller.md) - [All operations](https://skmtc.dev/y/apis/ai-caller/llms.txt) - [OpenAPI document](https://skmtc.dev/y/apis/ai-caller/revisions/05b629819b49?raw)