Onboarding
August 2024: We are currently rolling-out our new onboarding flow. New customers should expect to implement this from day one. Existing customers will be contacted by their dedicated Key Account Manager.
When creating a User to be paid on Aria, you may be required to complete an advanced onboarding in our system to enable future Loan approvals. This could involve one or both of the following steps:
- Onboarding the counterparty by uploading documents related to the individual and their business (KYB).
- Having them agree to our terms & conditions (T&Cs).
KYB
In some cases, you will need to send and validate documents through Aria. The required documents and a portal URL for your business contact will be provided in an Onboarding
. We recommend the following API flow:
- Subscribe to
onboarding
andonboarding.document
webhooks - Create a
User
. - Get notified by webhooks when the onboarding is created and the list documents that need to be uploaded.
- Send documents using the
portalUrl
returned in the Onboarding payload, also accessible on the User's dashboard view. - Get updated via webhooks:
onboarding
andonboarding.document
.
Each onboarding and document will come with a specific status and webhooks, allowing you to communicate with your counterparties regarding their onboarding status with Aria. If no onboarding is returned by our API, no document uploads are required for this counterparty.
You can either request your business contact to upload their documents or upload them yourself using our portalUrl
. This is our recommended method, but if you prefer to use our API, please contact us for guidance.
Onboarding status and portal links are also available on your dashboard.
The type of document required depends on:
- Business type: Regular companies will need to upload company documents in addition to the legal representative's ID document.
- Invoice owner capability: If your company account is configured with the user (
beneficiary
) as the default invoice owner or if the User'scanBeInvoiceOwner
istrue
, onboarding will be required.
Individual vs. company
When creating a User, you’ll be asked to fill a business type. If your User had some required documents to register their business with a government agency, you can use COMPANY
, otherwise you can consider your User as an INDIVIDUAL
.
Required documents*
Document Type | For These Business Types | Information |
---|---|---|
Legal Representative’s ID Document | Company, Individual | - |
Registration Certificate | Company, Individual | Can be fetched automatically depending on the country** |
Articles of Association | Company | Required only if the registration certificate is more than 3 months old. |
Ultimate Beneficial Owner Certificate | Company | Can be fetched automatically depending on the country** |
*Only required if company.config.currencyConfig.defaultInvoiceOwner = beneficiary
or if user.canBeInvoiceOwner = true
.
**Please reach out to your dedicated Integration or Key Account manager if you are interested in this feature.
Your Integration Manager and dedicated Key Account Manager are always available to help you understand the required documents for each case and how everything works if needed.
Refusal reasons
Onboarding and Onboarding documents come with refusalReasons, that are returned in english, for now.
Webhooks
You can subscribe to one of these events to be notified when a data has changed:
- onboarding.created
- onboarding.updated
- onboarding.document.created
- onboarding.document.updated
Webhook payloads
{
"date": string,
"event": "onboarding.created", // or "onboarding.updated"
"payload": {
id: string,
createdAt: string,
updatedAt: string,
targetType: string,
targetId: string,
status: string,
refusalReasons: Array
}
}
{
"date": string,
"event": "onboarding.document.created", // or "onboarding.document.created"
"payload": {
id: string,
createdAt: string,
updatedAt: string,
onboardingId: string,
type: string,
status: string,
refusalReasons: Array
}
}
T&Cs
To validate and pay a Loan, our Terms & Conditions (T&Cs) must be approved by the User and the Debtor. You can achieve this in two ways:
- Use our API to send an e-signature link by email to the User through the Send User Contract feature (not available for Debtors).
- Display our T&Cs on your platform and have them agreed upon by the User and notified to the Debtor.
The required counterparties and the best methodology will be defined during your onboarding process.
To comply with regulations, we plan to add timestamp endpoints in our API so you can record when a User or Debtor has validated our T&Cs.
Updated 17 days ago