Documentation
  • Welcome!
  • Getting started
    • Onboarding
    • Get your api credentials
  • Integration mode
    • Rest Api
      • πŸ‘©β€βœˆοΈPlatform
      • πŸ™KYC
        • ℹ️ID Informations
        • πŸ”ŽID Verification
        • πŸ†”ID Document Verification
          • πŸ–₯️User filled data verifications
        • β˜‘οΈFace match
        • 🧏Liveness check
      • πŸ‘¨β€πŸ’ΌKYB
        • ℹ️Company Informations
        • πŸ”ŽCompany Verification
        • πŸ—ƒοΈCompany Document Verification
      • 🚨AML
        • PEP
        • Sanction Lists
        • Media Adverse
      • πŸ”ŽRetrieve Document Verification result
    • SDK
      • JS
      • Java / Kotlin
      • Python
    • No-Code
      • Danaya Forms
    • WebView or iFrame
  • Webhook
Powered by GitBook
On this page
  • πŸ“₯ Integration URL
  • βœ… Completion Callback
  • Optional: JavaScript Event
  • πŸ“„ Required Documents
  • πŸ“‘ Verification Results
  • πŸ” Handling Duplicates
  • ❓Questions ?
  1. Integration mode

WebView or iFrame

πŸ“₯ Integration URL

Your integration URL should follow this structure:

https://{baseUrl}/v2/onboarding/{uuid}?product=productName&externalId=xxxxxx&partnerName=companyName&type=kyc

Parameters:

parameters
Description
required

uuid

Unique identifier for the onboarding session, provided by Danaya.

yes

product

The product type

yes

type

The onboarding type: kyc (individual) or kyb (business).

yes

externalId

Your internal user ID β€” used to match this onboarding session with your user.

yes

partnerName

Your partner identifier β€” used to verify your access.

yes

baseUrl

prod:app.danaya.africa demo: demo.danaya.africa

yes

βœ… Completion Callback

Once the user completes (or cancels) the onboarding flow, we redirect to:

https://{baseUrl}/v2/onboarding/end?isSuccess=true&requestId=uuid-verfication-request
parameters
Description

isSuccess

true is the documents are sent successfully and false if not

requestId

Optional: JavaScript Event

We can also emit a JavaScript event if you’re embedding in an iframe:

window.addEventListener("message", (event) => {
  if (event.data === "danaya:onboarding:complete") {
    // Close iframe or take appropriate action
    // do something with event.payload...
  }
});

Let us know if you’d like to use this event-based approach.

πŸ“„ Required Documents

Depending on the onboarding type (kyc or kyb), the user will need to provide specific documents:

KYC (Individual)

  • Selfie (required)

One of the following:

  • National ID (CNI)

  • Resident Permit

  • Passport

KYB (Business)

  • Selfie (required)

One of the following:

  • National ID (CNI)

  • Resident Permit

  • Passport

And company document

  • RCCM (required)

  • DFE (optional)

πŸ“‘ Verification Results

1. Webhook

  • We will send verification results to the webhook URL you provided during onboarding setup.

2. API Access

  • You can retrieve the verification results using either:

πŸ” Handling Duplicates

  • You can safely initiate multiple onboarding sessions using the same externalId.

  • When retrieving verification results by externalId, we will return only the most recent verification associated with it.

🚫 If a document is reused under a different externalId:

If a user uploads the same identity document with a new externalId, we will return an error when you try to retrieve the results:

{
  "code": "DUPLICATED_EXTERNAL_IDS",
  "duplicatedExternalIds": [
    "externalId-1",
    "externalId-2"
  ]
}

This indicates that the same document has already been processed under different externalIds.

❓Questions ?

PreviousDanaya FormsNextWebhook

Last updated 1 month ago

the file-verification-uuid. This will allow you to fetch the documents verification results. See this to how to use this id.

The requestId returned upon form submission

The externalId you used during initialization

If you have any questions or need help with the integration, please reach out to our team at .

here
here
support@danaya.africa
page