Skip to main content
GET
/
api
/
v1
/
customers
List customers
curl --request GET \
  --url http://localhost:45000/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "orgId": "<string>",
      "companyName": "<string>",
      "registrationNumber": "<string>",
      "countryOfIncorporationId": "<string>",
      "tradingNames": "<string>",
      "businessIndustryId": "<string>",
      "website": "<string>",
      "operationalChannels": "<string>",
      "businessEmail": "<string>",
      "primaryContactFirstName": "<string>",
      "primaryContactLastName": "<string>",
      "primaryContactPhone": "<string>",
      "primaryContactEmail": "<string>",
      "primaryContactIsAssociate": true,
      "businessType": "<string>",
      "formationDate": "<string>",
      "phone": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "stateProvinceRegion": "<string>",
      "postalCode": "<string>",
      "addressCountryId": "<string>",
      "estimatedAnnualRevenueUsd": "<string>",
      "expectedMonthlyPaymentsUsd": "<string>",
      "primaryBusinessPurpose": "<string>",
      "sourceOfFunds": "<string>",
      "taxIdType": "<string>",
      "taxIdentificationNumber": "<string>",
      "operatesInProhibitedCountries": true,
      "highRiskActivities": [
        "<string>"
      ],
      "transmitsCustomerFunds": true,
      "customerFundsDescription": "<string>",
      "conductsMoneyServices": true,
      "primaryPurposeOther": "<string>",
      "ownershipIndirectOrOffshoreStructures": "<string>",
      "ownershipTrustsFundsOrHoldingCompanies": true,
      "ownershipBranchesOrSubsidiaries": true,
      "ownershipBranchesOrSubsidiariesDetails": "<string>",
      "businessModelDescription": "<string>",
      "customerType": "<string>",
      "invoiceIssuance": "<string>",
      "productServiceCatalogueWithPrices": true,
      "mainCustomers": "<string>",
      "mainSuppliers": "<string>",
      "completeFlowOfFunds": "<string>",
      "significantCashVolumes": true,
      "holdsClientBalances": true,
      "receivesUnrelatedThirdPartyPayments": true,
      "primaryOperatingCurrency": "<string>",
      "fxConversion": true,
      "fxConversionDescription": "<string>",
      "endCustomersIdentified": "<string>",
      "countriesWhereOperatesOrCustomers": "<string>",
      "averageTransactionAmountUsd": "<string>",
      "geographicDistribution": "<string>",
      "registeredPaidInCapitalUsd": "<string>",
      "lastFinancialStatementsClosingDate": "<string>",
      "lastFinancialStatementsAudited": true,
      "virtualAccountPurpose": [
        "<string>"
      ],
      "virtualAccountPurposeOther": "<string>",
      "virtualAccountBalanceUsage": "<string>",
      "virtualAccountUseContext": "<string>",
      "fatfHighRiskExposure": "<string>",
      "sanctionsExposure": "<string>",
      "regulatedInAnyJurisdiction": true,
      "regulatedJurisdictionDetails": "<string>",
      "amlCftObligatedEntity": "<string>",
      "formalAmlCftProgramme": "<string>",
      "priorSanctionsInvestigations": true,
      "priorSanctionsInvestigationsDetails": "<string>",
      "bankingPspRelationships": "<string>",
      "pepDeclarationStatus": "<string>",
      "pepDeclarationDetails": "<string>",
      "pepAttestationSignerName": "<string>",
      "pepAttestationDocumentNumber": "<string>",
      "pepAttestationSignerTitle": "<string>",
      "pepAttestationCompanyName": "<string>",
      "pepDeclarationAttested": true,
      "status": "<string>",
      "currentStep": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "countryOfIncorporation": {
        "alpha2": "<string>",
        "name": "<string>"
      },
      "businessIndustry": {
        "code": "<string>",
        "name": "<string>"
      },
      "addressCountry": {
        "alpha2": "<string>",
        "name": "<string>"
      },
      "beneficiaryCount": 123,
      "paymentCount": 123,
      "persons": [
        {
          "id": "<string>",
          "customerId": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "roles": [
            "<string>"
          ],
          "ownershipPercent": 123,
          "nationalityId": "<string>",
          "dateOfBirth": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "addressLine1": "<string>",
          "addressLine2": "<string>",
          "city": "<string>",
          "stateProvinceRegion": "<string>",
          "postalCode": "<string>",
          "addressCountryId": "<string>",
          "taxIdentificationNumber": "<string>",
          "taxResidenceCountryId": "<string>",
          "businessTitle": "<string>",
          "relationshipEstablishedAt": "<string>",
          "idNumber": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "legalEntityShareholders": [
        {
          "id": "<string>",
          "customerId": "<string>",
          "companyLegalName": "<string>",
          "registrationNumber": "<string>",
          "countryOfIncorporationId": "<string>",
          "entityType": "<string>",
          "roles": [
            "<string>"
          ],
          "ownershipPercent": 123,
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "countryOfIncorporation": {
            "alpha2": "<string>",
            "name": "<string>"
          }
        }
      ]
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

Authorizations

x-api-key
string
header
required

Nuvera API application secret key

Authorization
string
header
required

RS256 per-request signed JWT

Query Parameters

status
enum<string>
Available options:
DRAFT,
PENDING_REVIEW,
CORRECTION_REQUESTED,
APPROVED,
REJECTED,
SUSPENDED
cursor
string
limit
integer
default:20
Required range: 1 <= x <= 100

Response

default - application/json
items
object[]
required
nextCursor
string | null
required
hasMore
boolean
required