This endpoint enables you to create individual customers. Once a customer is created, we initiate the KYC verification process automatically. You can then either poll the customer object or listen for webhooks to track the status change from PENDING_AGREEMENTS → VERIFIED or REJECTED.

How Embedded Partner Customer creation works

Embedded Wallets allow Embedded Partners (EP) to offer seamless payment and fund management capabilities directly within their platform while maintaining their branding. This guide provides a step-by-step process to create Embedded Partner Customer (EPC) accounts utilising Embedded Wallets via the BVNK Portal.

This product is available to businesses and individuals based in the US, EEA and other countries supported by BVNK outside of these regions.

EPC State transition diagram

The creation and verification lifecycle of an EPC follows a series of states—Pending Agreements, Info Required, Pending, Verified, and Rejected—which are illustrated and explained in this section.

Understanding these states (and how an EPC transitions between them) is key to a smooth onboarding process.

1. Pending Agreements
   • The EPC has been created but must consent to BVNK’s Terms of Service.
   • An agreements link is generated and must be shared with the EPC to collect consent.
2. Info Required
   • After Terms are signed, BVNK requires additional verification information (KYB/KYC).
   • A verification link is provided for the EP to provide their Customer's (EPC) data and documents.
3. Pending
   • Once verification flow is submitted, BVNK performs compliance checks.
   • During this time, you can monitor the EPC’s status in the portal.
4. Verified
   • The EPC has successfully passed the compliance review.
   • Wallets can now be created and used.
5. Rejected
   • The EPC has failed compliance checks or provided invalid information.
   • The flow halts unless additional data is requested and submitted for reconsideration.

Important

• Ensure accurate personal data (name, DOB, nationality, address) is collected to facilitate a smooth KYC process.
• A successful response includes a unique customer reference for tracking verification status.
• Customer Due Diligence (CDD) data is required.

🚧

Early Access

Please note that this endpoint is currently in early access, and it may undergo changes as we continue to improve and refine the functionality.

📘

Prerequisites

You will need to collect information about the customer before proceeding with the request to create one.

📘

Idempotency supported endpoint

This means you can retry a request without worrying about it being processed multiple times.

To use this feature, add the X-Idempotency-Key header with a unique value (a UUID). This ensures the request is only processed once, even if it's sent multiple times.

Create an Individual Customer

Endpoints

Request

Example - individual customer creation:

curl --location 'https://api.sandbox.bvnk.com/platform/v1/customers' \
--header 'X-Idempotency-Key: 86b5f133-9ee8-4f67-8747-7c9d0894a68b' \
--header 'Content-Type: application/json' \
--header 'Authorization: Hawk id="YourHawkID", ts="1728655954", nonce="abc123", mac="..."' \
--data-raw {
    "type": "INDIVIDUAL",
    "riskScore": "LOW", 
    "individual": {
        "description": "Transfers to/from Own Wallet (including Bank Accounts)",
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "1990-05-12",
        "nationality": "US",
        "birthCountryCode": "US",
        "emailAddress": "[email protected]",
        "phoneNumber": "+1234567890", 
        "address": {
            "addressLine1": "123 Main St",
            "city": "New York",
            "postalCode": "10001", 
            "stateCode": "NY",
            "countryCode": "US"
        },
        "taxIdentification": { 
            "number": "123-45-6789",
            "taxResidenceCountryCode": "US"
        },
        "cdd": {
            "employmentStatus": "Salaried",
            "sourceOfFunds": "Salary / Employment Income",
            "pepStatus": "Not a PEP",
            "expectedMonthlyVolume": {
                "amount": "500.01",
                "currency": "EUR" },// optional, defaults to 'USD' if not specified
        }
    }
},
  "signedAgreementSessionReference": "78eedde1-2402-4a59-8bbd-ccecb6d612d1"
}

Request Body Parameters (Individual)

Response

{
  "reference": "f81a5b62-27b8-4b3b-b51e-eb10edeb1731",
  "status": "INFO_REQUIRED"
}

Add Documents to an Individual Customer

• Use these endpoints to attach documents to an Individual customer.
• Each request can upload multiple documents simultaneously.

Important

• Reference the correct customerReference.
• Files must be base64-encoded before sending.

Endpoints

Add Document(s)

Request Example

curl --location 'https://api.sandbox.bvnk.com/platform/v1/customers/123e4567-e89b-12d3-a456-426614174000/documents' \
--header 'Content-Type: application/json' \
--header 'Authorization: Hawk id="YourHawkID", ts="1678900000", nonce="abc123", mac="xyz789..."' \
--data-raw '[
  {
    "customerPersonReference": "9b2c3d4e-567f-48f0-abc1-03a4e3df12ab",
    "type": "PASSPORT",
    "subType": "FRONT_SIDE",
    "name": "John Smith Passport.pdf",
    "description": "Document optional description",
    "countryCode": "GB",
    "externalReference": "2b8d8bde-eef5-408a-9228-96bef24865ad",
    "content": "JVBERi0xLjUKJeLjz9MKMSAwIG9iago8PC9UeXBlIC9QYWdl..."
  }
]'

Path Parameter

Request Body Parameters

Response

Success Example:

{
  "reference": "d42e1c62-27b8-4b3b-b51e-eb10edeb1731",
  "externalReference": "2b8d8bde-eef5-408a-9228-96bef24865ad",
  "status": "INIT"
}

Failure Example:

{
  "code": "DOCUMENTS-4000",
  "status": "BAD_REQUEST",
  "message": "Invalid document content",
  "details": {
    "errors": {
      "content": [
        "Document file content is not valid base64"
      ]
    }
  }
}

Additional Document APIs

Search Documents

GET /platform/v1/customers/documents

Optional Query Parameters:

• customerReference
• externalReference
• name
• types
• subTypes
• statuses (e.g., INIT, PENDING, APPROVED, DECLINED)

Get Document Download URL

GET /platform/v1/customers/documents/{documentReference}/url

Returns a temporary URL for document download.

Delete Document

DELETE /platform/v1/customers/documents/{documentReference}

Returns 204 No Content if successfully deleted.

Good to Know

1. Check Document Status
   Retrieve the customer or associated person object to confirm document verification status.

2. Retain Document References
   Store the reference returned in the success response for future queries or audits.

3. Combine with KYC
   Document verification may be required before the customer status changes from PENDING to VERIFIED.

Complete Onboarding

Once you have uploaded all required documentation for an Embedded Partner Customer (EPC), you must confirm the completion of the onboarding process by calling the following endpoint:

Endpoint

Path Parameters

What Happens Next?

When you successfully call this endpoint:

• BVNK will initiate final compliance and verification checks.
• In the sandbox environment, EPC verification is automatically approved.
• In production, if the EPC meets all compliance requirements, the status will update to VERIFIED. If there are outstanding requirements or issues, the status will move to INFO_REQUIRED or REJECTED, prompting manual review or further actions.

Monitoring Status

You can monitor the EPC's verification status via:

• API: Retrieve current status using GET /platform/v1/customers/{reference}
• Portal: Track progress and statuses directly through the BVNK Portal
• Webhooks: Set up webhooks to receive automated updates on status changes.