v1
latestOpenAPI 3.0.02026-07-26167441.9 MBEntity Onboarding (Banking Connectivity)
Create Entity Onboarding (Banking Connectivity)
post/banking/entities/{entity_id}/onboardings
Path parameters
entity_idstring required
The id of the entity obtained from Create Entity.
Headers
x-idempotency-keystring 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).
Request body
Example request
{
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"yuno_connection_id": "conn_550e8400-e29b-41d4-a716-446655440001",
"onboarding_type": "ONE_STEP",
"compliance_declaration": {
"terms_of_service": {
"accepted": true,
"version": "1.2.0",
"accepted_at": "2026-02-01T10:00:00Z",
"accepted_ip": "192.168.1.1"
},
"privacy_policy": {
"accepted": true,
"version": "2.1.0",
"accepted_at": "2026-02-01T10:00:00Z",
"accepted_ip": "192.168.1.1"
}
},
"risk_assessment": {
"assessed_at": "2026-02-01T10:00:00Z",
"rca_status": {
"risk_level": "LOW",
"classified_at": "2026-02-01T10:00:00Z",
"assessed_by": "Merchant Compliance Team"
},
"sanctions_screening": {
"screened_at": "2026-02-01T09:00:00Z"
}
},
"source_of_funds": {
"primary_source": "EMPLOYMENT_SALARY",
"secondary_sources": [
"INVESTMENTS"
],
"description": "Primary income from full-time employment as software engineer, supplemented by stock portfolio dividends",
"estimated_annual_income": {
"amount": 175000,
"currency": "USD"
}
},
"documentation": [
{
"type": "IDENTITY_DOCUMENT",
"identity_document": {
"subtype": "DRIVERS_LICENSE",
"document_number": "D1234567",
"issuing_country": "US",
"issuing_state": "CA",
"issued_at": "2020-01-15",
"expires_at": "2028-01-15",
"front_image": {
"file_name": "license_front.jpg",
"content_type": "image/jpeg",
"content": "base64_encoded_content"
},
"back_image": {
"file_name": "license_back.jpg",
"content_type": "image/jpeg",
"content": "base64_encoded_content"
}
},
"proof_of_address": {
"subtype": "UTILITY_BILL",
"provider_name": "PG&E",
"bill_type": "ELECTRICITY",
"issued_at": "2026-01-01",
"account_number": "ACC-123456",
"verified_address": {
"address_line_1": "123 Main St",
"city": "San Francisco",
"state": "CA",
"zip_code": "94102",
"country": "US"
},
"file": {
"file_name": "utility_bill.pdf",
"content_type": "application/pdf",
"content": "base64_encoded_content"
}
},
"bank_statement": {
"bank_name": "Chase Bank",
"account_number_last_4": "1234",
"statement_period_start": "2025-12-01",
"statement_period_end": "2025-12-31",
"file": {
"file_name": "bank_statement_dec_2025.pdf",
"content_type": "application/pdf",
"content": "base64_encoded_content"
}
},
"business_document": {
"subtype": "ARTICLES_OF_INCORPORATION",
"registration_number": "REG-2020-12345",
"registered_at": "2020-01-15",
"issuing_state": "CA",
"issuing_authority": "California Secretary of State",
"file": {
"file_name": "articles_of_incorporation.pdf",
"content_type": "application/pdf",
"content": "base64_encoded_content"
}
},
"tax_information": {
"tax_records": [
{
"country": "US",
"tax_id": "123-45-6789",
"tax_id_type": "SSN",
"is_primary": true
}
],
"tax_document_type": "W9",
"tax_year": "2025",
"issuing_authority": "IRS",
"file": {
"file_name": "w9_form.pdf",
"content_type": "application/pdf",
"content": "base64_encoded_content"
}
},
"financial_document": {
"subtype": "BALANCE_SHEET",
"period_start": "2025-01-01",
"period_end": "2025-12-31",
"fiscal_year": "2025",
"file": {
"file_name": "balance_sheet_2025.pdf",
"content_type": "application/pdf",
"content": "base64_encoded_content"
}
},
"biometric_verification": {
"verification_method": "FACIAL_RECOGNITION",
"capture_method": "LIVE_CAPTURE",
"capture_timestamp": "2026-02-01T10:00:00Z",
"liveness_check_passed": true,
"confidence_score": 0.98,
"verification_provider": "Onfido",
"live_image": {
"file_name": "live_capture.jpg",
"content_type": "image/jpeg",
"content": "base64_encoded_content"
},
"reference_image": {
"file_name": "id_photo_reference.jpg",
"content_type": "image/jpeg",
"content": "base64_encoded_content"
}
},
"employment_information": {
"status": "EMPLOYED",
"employer_name": "Tech Corp Inc",
"occupation": "Senior Software Engineer",
"industry": "TECHNOLOGY",
"started_at": "2020-03-15",
"annual_income": {
"amount": 150000,
"currency": "USD"
},
"verification_document": {
"file_name": "employment_letter.pdf",
"content_type": "application/pdf",
"content": "base64_encoded_content"
}
}
}
]
}