This guide outlines the process for verifying a business using our API. Follow these steps to ensure a smooth and efficient onboarding process for your clients.Step-by-step guide#
1. Create a New Submission#
Start by collecting essential business attributes from the applicant during your onboarding flow. Use this information to create a new submission for the business. This step is crucial as it registers the business in Niva's system.Creating a new submission will not automatically start the application process. You must trigger this process after uploading the relevant documents (see Step 2).
2. Upload and Validate Documents#
After creating a submission, the next step is to upload the required documents. Use the document upload endpoint to upload each document one by one.Document Upload Details:#
- Document Type: Specify the type of document being uploaded (e.g., business license, incorporation document).
- File: The actual document file in JPG, PNG, or PDF format.When you upload a document, the system will:
- Perform a quick validation (usually within 15 seconds) to check if the document is valid.
- Return an HTTP 400 status if the document is invalid (e.g., document is empty, illegible, or of the incorrect type).
- Return an HTTP 202 status if the document cannot be verified within 30 seconds. A webhook notification will be sent once the document is validated.3. Handle Document Validation Results#
Validation results can be handled either through immediate feedback or webhook notifications.- Immediate Feedback: If the document is validated within 30 seconds, you will receive a direct response indicating whether the document is valid or invalid.
- Webhook Notifications: For documents taking longer to validate, you'll receive a webhook notification with the results. You can also fetch the submission details to check the validation status.4. Run the Submission#
Once all required documents are uploaded and validated, initiate the business application (KYB) process by calling the trigger endpoint. This step starts the full KYB analysis.- Webhook Notification: You will receive a webhook notification with the status of the submission once processing is complete.
- Processing Time: Most submissions are processed within minutes, but some may require additional review by our internal team and take longer.5. Fetch Submission Status#
Possible Statuses:
- needs_review: The submission requires further review.
- approved: The submission has been approved.
- rejected: The submission has been rejected.Sequence Diagram#
This guide provides a step-by-step process to verify a business using our API. For more detailed information on each endpoint, refer to the individual endpoint documentation sections.Support#
If you encounter any issues or have questions, please contact our support team at support@niva.co.