Submit Onboarding

The Submit Onboarding API allows you to submit comprehensive onboarding information for a business, including business details, member information, and policy agreements.

Resource Access

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/yield/v1/businesses/{businessId}/onboarding

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/yield/v1/businesses/{businessId}/onboarding

Path Parameters

Parameter	Required	Type	Description	Example
`businessId`	Yes	string	The unique identifier for the business	eaeee8b9-d043-0d9e-4cd0-7fcae504e00d

Request Body

The request body contains three main sections:

Business Information

Field	Type	Required	Description	Example
`have_interested_parties_to_report`	boolean	No	Whether there are interested parties to report	`false`
`addresses`	array	No	Array of business addresses	See sample
`phone_number`	object	No	Business phone number with country code	`{"country_code": "+1", "phone_number": "9036334086"}`
`business_description`	string	No	Description of the business	`"123"`
`business_type`	string	No	Type of business entity	`"llc"`
`tax_classification`	string	No	Tax classification	`"c_corporation"`
`investment_objective`	string	No	Investment objective	`"capital_preservation"`
`industry_type`	string	No	Industry type	`"mining"`
`tax_identification_number`	string	No	Tax identification number	`"123123123"`
`annual_gross_revenue`	object	No	Annual gross revenue with currency	`{"currency": "USD", "amount": "9000.00"}`
`total_liquid_assets`	object	No	Total liquid assets with currency	`{"currency": "USD", "amount": "9001.00"}`
`exempt_listing_beneficial_owners`	boolean	No	Whether beneficial owners are exempt	`false`
`foreign_financial_institution`	boolean	No	Whether this is a foreign financial institution	`false`
`business_members`	array	No	Array of business members	`[]`

Business Member Onboarding

Field	Type	Required	Description	Example
`first_name`	string	Yes	First name	`"Bob"`
`last_name`	string	Yes	Last name	`"John"`
`date_of_birth`	object	Yes	Date of birth	`{"month": 1, "day": 1, "year": 1950}`
`residency_country`	string	Yes	Country of residency	`"USA"`
`citizenship_country`	string	Yes	Country of citizenship	`"USA"`
`job_title`	string	Yes	Job title	`"CEO"`
`is_entity_officer`	boolean	Yes	Whether this person is an entity officer	`true`
`phone_number`	object	Yes	Phone number with country code	`{"country_code": "+1", "phone_number": "5613688385"}`
`is_authorized_signer`	boolean	Yes	Whether this person is an authorized signer	`true`
`addresses`	array	Yes	Array of personal addresses	See sample
`ownership_percentage`	number	Yes	Ownership percentage	`0`
`leader_of_public_company`	boolean	Yes	Whether this person leads a public company	`false`
`broker_dealer`	boolean	Yes	Whether this person is a broker dealer	`false`
`large_trader`	boolean	Yes	Whether this person is a large trader	`false`
`stock_exchange_finra_member_associated`	boolean	Yes	Whether associated with FINRA member	`false`
`politically_exposed`	boolean	Yes	Whether politically exposed	`false`
`national_identifier`	string	Yes	National identifier	`"123456789"`
`email`	string	Yes	Email address	`"test@gmail.com"`

Policies

Field	Type	Required	Description	Example
`bank_account_agreement`	boolean	Yes	Bank account agreement acceptance	`true`
`investment_management_agreement`	boolean	Yes	Investment management agreement acceptance	`true`
`entity_llc_agreement`	boolean	Yes	Entity LLC agreement acceptance	`true`
`entity_corporation_cash_account_agreement`	boolean	Yes	Entity corporation cash account agreement	`false`
`entity_new_account_ria`	boolean	Yes	Entity new account RIA acceptance	`true`

Response

Field	Type	Description	Example
`id`	string	Unique business ID	eaeee8b9-d043-0d9e-4cd0-7fcae504e00d
`legal_name`	string	Legal name of the business	Ahrvo Network Financial
`doing_business_as`	string	Doing business as name	Ahrvo Network
`status`	string	Business status	CLOSED
`sub_status`	string	Business sub-status	cupidatat adipisicing
`user_data`	object	User data object	`{"deserunt2": true, "sint2": 69510956.00821519}`
`created_at`	string	Creation timestamp (ISO 8601)	2022-01-01T00:00:00.000Z
`updated_at`	string	Last update timestamp (ISO 8601)	2022-01-01T00:00:00.000Z

Sample Request

POST /banking/yield/v1/businesses/eaeee8b9-d043-0d9e-4cd0-7fcae504e00d/onboarding HTTP/1.1
Host: <hostname>
Authorization: Bearer <JWT token>
x-api-key: {apiKey}
Content-Type: application/json

{
    "business": {
        "have_interested_parties_to_report": false,
        "addresses": [
            {
                "address1": "123 Main St",
                "address2": null,
                "city": "San Francisco",
                "postal_code": "94016",
                "region": "CA",
                "country": "USA"
            }
        ],
        "phone_number": {
            "country_code": "+1",
            "phone_number": "9036334086"
        },
        "business_description": "123",
        "business_type": "llc",
        "tax_classification": "c_corporation",
        "investment_objective": "capital_preservation",
        "industry_type": "mining",
        "tax_identification_number": "123123123",
        "annual_gross_revenue": {
            "currency": "USD",
            "amount": "9000.00"
        },
        "total_liquid_assets": {
            "currency": "USD",
            "amount": "9001.00"
        },
        "exempt_listing_beneficial_owners": false,
        "foreign_financial_institution": false,
        "business_members": []
    },
    "business_member_onboarding": {
        "first_name": "Bob",
        "last_name": "John",
        "date_of_birth": {
            "month": 1,
            "day": 1,
            "year": 1950
        },
        "residency_country": "USA",
        "citizenship_country": "USA",
        "job_title": "CEO",
        "is_entity_officer": true,
        "phone_number": {
            "country_code": "+1",
            "phone_number": "5613688385"
        },
        "is_authorized_signer": true,
        "addresses": [
            {
                "address1": "123 Main St",
                "address2": null,
                "city": "San Francisco",
                "postal_code": "94016",
                "region": "CA",
                "country": "USA"
            }
        ],
        "ownership_percentage": 0,
        "leader_of_public_company": false,
        "broker_dealer": false,
        "large_trader": false,
        "stock_exchange_finra_member_associated": false,
        "politically_exposed": false,
        "national_identifier": "123456789",
        "email": "test@gmail.com"
    },
    "policies": {
        "bank_account_agreement": true,
        "investment_management_agreement": true,
        "entity_llc_agreement": true,
        "entity_corporation_cash_account_agreement": false,
        "entity_new_account_ria": true
    }
}

Sample Response

{
  "legal_name": "Ahrvo Network Financial",
  "id": "eaeee8b9-d043-0d9e-4cd0-7fcae504e00d",
  "created_at": "2022-01-01T00:00:00.000Z",
  "updated_at": "2022-01-01T00:00:00.000Z",
  "doing_business_as": "Ahrvo Network",
  "status": "CLOSED",
  "sub_status": "cupidatat adipisicing",
  "user_data": {
    "deserunt2": true,
    "sint2": 69510956.00821519,
    "enim_12": true,
    "nulla_15": 27801090.432306945
  }
}

HTTP/1.1 200 OK

Resource Access​

Path Parameters​

Request Body​

Business Information​

Business Member Onboarding​

Policies​

Response​

Sample Request​

Sample Response​

OpenAPI Specification​