Skip to main content

Onboarding (New) - Overview

Introduction​

The Onboarding (New) API enables automated onboarding, identity verification, company profile registration, document submission, and KYC evaluation for businesses and downstream sub-accounts.

By integrating the Onboarding API, you can submit compliance dossiers, track verification states across internal review and Request for Information (RFI) stages, upload required governance documents via pre-signed links, and activate corporate accounts for global financial operations.

Key Capabilities​

  • Company Data Submission: Submit company details, legal entity structures, registered addresses, and corporate governance info.
  • Product Selection: Configure active banking services (Collect, Convert, Pay, Hold, API) per corporate profile.
  • Beneficial Owners & Shareholders: Register corporate shareholders and ultimate beneficial owners (UBOs) with individual KYC metrics.
  • Pre-signed Document Uploads: Obtain time-limited, secure S3 URLs to upload incorporation certificates, proof of address, and identity papers directly to cloud storage.
  • Lifecycle & Review Tracking: Query onboarding progress, review notes, RFI items, and compliance decisions in real-time.

Authentication​

All Onboarding API endpoints require authentication using a Bearer token in the Authorization header.

Authorization: Bearer <your_access_token>

An optional x-api-key header may also be supplied for tenant-based routing.

Base URLs​

Production: https://api.ahrvo.network
Staging:    https://gateway.ahrvo.network

Common Headers​

HeaderValueRequiredDescription
AuthorizationBearer {token}YesJWT Bearer access token
Content-Typeapplication/jsonYes (for POST)Request payload format
Acceptapplication/jsonYesResponse payload format
x-api-keystringNoOptional API key for merchant routing

Available Endpoints​

MethodEndpointDescription
POST/companies/{companyId}/onboarding-dataSubmit or update full onboarding dossier for a company
GET/companies/{companyId}/onboarding-dataRetrieve submitted onboarding dossier, verification status, and review progress
POST/documents/generate-upload-linkGenerate a pre-signed 10-minute upload URL for compliance documents

Onboarding Lifecycle Workflow​

sequenceDiagram
    autonumber
    actor Client as Partner / Client
    participant API as Onboarding API
    participant S3 as Secure File Storage
    participant Compliance as Compliance Engine

    Client->>API: POST /documents/generate-upload-link (fileName, documentTypeId)
    API-->>Client: 200 OK (upload URL, documentKey)
    Client->>S3: PUT binary file to pre-signed URL
    S3-->>Client: 200 OK (Upload confirmed)

    Client->>API: POST /companies/{companyId}/onboarding-data (dossier + documentKey)
    API->>Compliance: Trigger automated background checks & KYC
    API-->>Client: 200 OK (status: PENDING / UNDER_REVIEW)

    loop Verification Polling / Webhook
        Client->>API: GET /companies/{companyId}/onboarding-data
        API-->>Client: 200 OK (status: APPROVED / RFI / UNDER_REVIEW)
    end

Next Steps​