Skip to main content
GET
/
api
/
v1
/
customers
/
{id}
Get customer detail
curl --request GET \
  --url http://localhost:45000/api/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'
{
  "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>"
      }
    }
  ]
}

Authorizations

x-api-key
string
header
required

Nuvera API application secret key

Authorization
string
header
required

RS256 per-request signed JWT

Path Parameters

id
string
required

Response

default - application/json
id
string
required
orgId
string
required
companyName
string
required
registrationNumber
string
required
countryOfIncorporationId
string | null
required
tradingNames
string | null
required
businessIndustryId
string | null
required
website
string | null
required
operationalChannels
string | null
required
businessEmail
string | null
required
primaryContactFirstName
string | null
required
primaryContactLastName
string | null
required
primaryContactPhone
string | null
required
primaryContactEmail
string | null
required
primaryContactIsAssociate
boolean | null
required
businessType
string | null
required
formationDate
string | null
required
phone
string | null
required
addressLine1
string | null
required
addressLine2
string | null
required
city
string | null
required
stateProvinceRegion
string | null
required
postalCode
string | null
required
addressCountryId
string | null
required
estimatedAnnualRevenueUsd
string | null
required
expectedMonthlyPaymentsUsd
string
required
primaryBusinessPurpose
string | null
required
sourceOfFunds
string | null
required
taxIdType
string | null
required
taxIdentificationNumber
string | null
required
operatesInProhibitedCountries
boolean | null
required
highRiskActivities
string[] | null
required
transmitsCustomerFunds
boolean | null
required
customerFundsDescription
string | null
required
conductsMoneyServices
boolean | null
required
primaryPurposeOther
string | null
required
ownershipIndirectOrOffshoreStructures
string | null
required
ownershipTrustsFundsOrHoldingCompanies
boolean | null
required
ownershipBranchesOrSubsidiaries
boolean | null
required
ownershipBranchesOrSubsidiariesDetails
string | null
required
businessModelDescription
string | null
required
customerType
string | null
required
invoiceIssuance
string | null
required
productServiceCatalogueWithPrices
boolean | null
required
mainCustomers
string | null
required
mainSuppliers
string | null
required
completeFlowOfFunds
string | null
required
significantCashVolumes
boolean | null
required
holdsClientBalances
boolean | null
required
receivesUnrelatedThirdPartyPayments
boolean | null
required
primaryOperatingCurrency
string | null
required
fxConversion
boolean | null
required
fxConversionDescription
string | null
required
endCustomersIdentified
string | null
required
countriesWhereOperatesOrCustomers
string | null
required
averageTransactionAmountUsd
string | null
required
geographicDistribution
string | null
required
registeredPaidInCapitalUsd
string | null
required
lastFinancialStatementsClosingDate
string | null
required
lastFinancialStatementsAudited
boolean | null
required
virtualAccountPurpose
string[] | null
required
virtualAccountPurposeOther
string | null
required
virtualAccountBalanceUsage
string | null
required
virtualAccountUseContext
string | null
required
fatfHighRiskExposure
string | null
required
sanctionsExposure
string | null
required
regulatedInAnyJurisdiction
boolean | null
required
regulatedJurisdictionDetails
string | null
required
amlCftObligatedEntity
string | null
required
formalAmlCftProgramme
string | null
required
priorSanctionsInvestigations
boolean | null
required
priorSanctionsInvestigationsDetails
string | null
required
bankingPspRelationships
string | null
required
pepDeclarationStatus
string | null
required
pepDeclarationDetails
string | null
required
pepAttestationSignerName
string | null
required
pepAttestationDocumentNumber
string | null
required
pepAttestationSignerTitle
string | null
required
pepAttestationCompanyName
string | null
required
pepDeclarationAttested
boolean | null
required
status
string
required
currentStep
number
required
createdAt
string
required
updatedAt
string
required
countryOfIncorporation
object
businessIndustry
object
addressCountry
object
beneficiaryCount
number
paymentCount
number
persons
object[]