Retrieve Customer Details

With these endpoints, you can retrieve information about a specific Embedded Partner Customer within the system: key customer data, including their profile, associated wallets, and other relevant details. You can list all EPCs or acquire details of a specific one.


📘

Note

This endpoint includes pagination.

  • page: page number which starts from 0
  • size: page size which limits the number of returned customers in the response

Retrieve all Embedded Partner Customers

To get a list of all EPCs in the system, send the GET/customers request.

In the response, you will receive the complete list of customers with the details:

{
    "content": [
        {
            "reference": "8a0e1da2-2af3-4b9e-a221-e74db4e01b06",
            "status": "VERIFIED",
            "type": "COMPANY",
            "model": "EMBEDDED",
            "name": "LB Ltd.",
            "description": "Embedded customer"
        },
        {
            "reference": "e38af699-5595-4ec4-a4d3-89b85e4fc906",
            "status": "PENDING",
            "type": "COMPANY",
            "model": "EMBEDDED",
            "name": "The Walt Disney company",
            "description": "Embedded customer two"
        }
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 2,
        "sort": {
            "empty": true,
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalPages": 42,
    "totalElements": 83,
    "first": true,
    "size": 2,
    "number": 0,
    "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
    },
    "numberOfElements": 2,
    "empty": false
}

Retrieve EPC details

To get the detailed information of a specific Embedded Partner Customer, send the GET customers/{customerReference} with the {customerReference} specified in the path.

In the successful response, you receive a detailed information on this customer:

{
    "reference": "8a0e1da2-2af3-4b9e-a221-e74db4e01b06",
    "status": "PENDING",
    "type": "COMPANY",
    "company": {
        "name": "LB Ltd.",
        "description": "Embedded customer",
        "taxResidenceCountryCode": "US",
        "registrationNumber": "21-4532998",
        "address": {
            "addressLine1": "101 West Broadway",
            "addressLine2": "Suite 1975",
            "city": "San Diego",
            "postalCode": "92101",
            "countryCode": "US",
            "country": "United States"
        },
        "associates": [
            {
                "person": {
                    "reference": "911685b0-acaa-418d-bd91-ed80b96c62cf",
                    "firstName": "Sean",
                    "lastName": "Bond",
                    "dateOfBirth": "2001-01-31",
                    "address": {
                        "addressLine1": "101 West Broadway",
                        "addressLine2": "Suite 1975",
                        "city": "San Diego",
                        "postalCode": "92101",
                        "countryCode": "US",
                        "country": "United States"
                    }
                },
                "details": {
                    "birthCountryCode": "US",
                    "contactInfo": {
                        "emailAddress": "[email protected]",
                        "phoneNumber": "+123456789"
                    },
                    "documentNumber": "123456789",
                    "documentInfo": {
                        "number": "123456789",
                        "type": "DRIVERS_LICENSE",
                        "issuingCountryCode": "US"
                    },
                    "taxIdentification": {
                        "number": "914764628",
                        "taxResidenceCountryCode": "US"
                    }
                },
                "title": "CEO",
                "riskScore": "LOW",
                "controls": {
                    "hasOwnership": true,
                    "hasControl": true,
                    "isSigner": false
                },
                "verification": {
                    "url": "https://sumsub.com/2",
                    "status": "infoRequired"
                }
            },
            {
                "person": {
                    "reference": "c4cfa062-ea5f-49ca-96e0-8495e648520e",
                    "firstName": "Luke",
                    "lastName": "Dickens",
                    "dateOfBirth": "2001-01-31",
                    "address": {
                        "addressLine1": "101 West Broadway",
                        "addressLine2": "Suite 1975",
                        "city": "San Diego",
                        "postalCode": "92101",
                        "countryCode": "US",
                        "country": "United States"
                    }
                },
                "details": {
                    "birthCountryCode": "US",
                    "contactInfo": {
                        "emailAddress": "[email protected]",
                        "phoneNumber": "+123456789"
                    },
                    "documentNumber": "123456789",
                    "documentInfo": {
                        "number": "123456789",
                        "type": "DRIVERS_LICENSE",
                        "issuingCountryCode": "US"
                    },
                    "taxIdentification": {
                        "number": "914764628",
                        "taxResidenceCountryCode": "US"
                    }
                },
                "title": "Representative",
                "riskScore": "LOW",
                "controls": {
                    "hasOwnership": false,
                    "hasControl": false,
                    "isSigner": true
                },
                "verification": {
                    "url": "https://sumsub.com/3",
                    "status": "infoRequired"
                }
            }
        ],
        "verification": {
            "url": "https://sumsub.com/1",
            "status": "infoRequired"
        }
    },
    "riskScore": "LOW"
}

Attribute

Type

Description

reference

String

A unique identifier for the customer request.

status

String

Status of the customer (e.g., "VERIFIED"). Possible statuses could include PENDING, VERIFIED, REJECTED.

type

String

The type of customer.

company

Object

Details about the company.

company.name

String

Name of the company.

company.description

String

Description of the company.

company.taxResidenceCountryCode

String

Country code for tax residence.

company.registrationNumber

String

Registration number of the company.

company.industry

Object

The industry details of the company.

company.industry.
reference

String

Industry reference ID.

company.industry.
name

String

Name of the industry.

company.address

Object

The address of the company.

company.address.
addressLine1

String

Primary address line.

company.address.
addressLine2

String

Secondary address line.

company.address.
postalCode

String

Postal code.

company.address.
city

String

City.

company.address.
countryCode

String

Country code.

company.address.
country

String

Full country name.

company.associates

Object

The representative of the company.

company.associates.person.
reference

String

Unique reference of the associated individual

company.associates.person.
firstName

String

First name of the associated individual.

company.associates.person.
lastName

String

Last name of the representative.

company.associates.person.
dateOfBirth

String

Date of birth of the representative.

company.associates.person.
address

Object

The representative address of the company.

company.associates.person.address.
addressLine1

String

Primary address line of the representative.

company.associates.person.address.
addressLine2

String

Secondary address line of the representative.

company.associates.person.address.
postalCode

String

Postal code of the representative.

company.associates.person.address.
city

String

City of the representative.

company.associates.person..address.
countryCode

String

Country code of the representative.

company.associates.person..address.
country

String

Full country name of the representative.


Retrieve Customer details by specifying page and size

Request

EnvironmentEndpoint
ProductionGET https://api.bvnk.com/platform/v1/customers?page={page}&size={size}
SandboxGET https://api.sandbox.bvnk.com/platform/v1/customers?page={page}&size={size}\
curl --location 'https://api.sandbox.bvnk.com/platform/v1/customers?page=0&size=20' \
--header 'Authorization: Hawk id="vbfc61D890wg6LAAVbkR11qP9O6cXeMNmKWgcUNZaOHPiQeebp9cl6h02tWv84R8", ts="1728656129", nonce="nt0eD9", mac="gv77Nu/nVWEQo8sfp/leXrC8xVs6UlOG+AoxZlyltJw="'

Response

{
    "content": [
        {
            "reference": "61461ad5-0599-4a4a-8e4e-c2575605f5bb",
            "status": "PENDING",
            "type": "COMPANY",
            "name": "UK Ltd Version 2.0",
            "description": "Number 1 customer, be super nice."
        },
        {
            "reference": "60bf3fed-7e76-4cc8-9c1f-e0f19878e0c8",
            "status": "PENDING",
            "type": "COMPANY",
            "name": "UK Ltd Version 2.0",
            "description": "Number 1 customer, be super nice."
        }
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 2,
        "sort": {
            "empty": true,
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalPages": 5,
    "totalElements": 9,
    "first": true,
    "size": 2,
    "number": 0,
    "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
    },
    "numberOfElements": 2,
    "empty": false
}

Pageable details:

AttributeTypeDescription
pageNumberIntegerCurrent page number (e.g., 0 for the first page).
pageSizeIntegerNumber of records per page (e.g., 2).
sort.emptyBooleanWhether the sort criteria is empty (true means no sorting).
sort.sortedBooleanWhether the results are sorted (false means no sorting).
sort.unsortedBooleanWhether the results are unsorted (true means not sorted).
offsetIntegerOffset of the first record (e.g., 0, meaning no offset).
pagedBooleanWhether the results are paginated (true).
unpagedBooleanWhether the results are not paginated (false).
lastBooleanWhether this is the last page of results (false means more pages exist).
totalPagesIntegerTotal number of pages (e.g., 10 pages).
totalElementsIntegerTotal number of elements across all pages (e.g., 20 elements).
firstBooleanWhether this is the first page (true).
sizeIntegerNumber of elements per page (e.g., 2).
numberIntegerThe current page number (e.g., 0 for the first page).
sort.emptyBooleanWhether the sort criteria is empty (true).
sort.sortedBooleanWhether the results are sorted (false).
sort.unsortedBooleanWhether the results are unsorted (true).
numberOfElementsIntegerNumber of elements in the current page (e.g., 2).
emptyBooleanWhether the page is empty (false means there are elements).

What’s Next

Before finishing the onboarding of Customers, request their compliance data via questionnaires.