Skip to main content
PATCH
/
api
/
v1
/
customers
/
{id}
Update customer
curl --request PATCH \
  --url http://localhost:45000/api/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "id": "<string>",
  "companyName": "<string>",
  "registrationNumber": "<string>",
  "countryOfIncorporationId": "<string>",
  "tradingNames": "<string>",
  "businessIndustryId": "<string>",
  "website": "<string>",
  "operationalChannels": "<string>",
  "businessEmail": "jsmith@example.com",
  "primaryContactFirstName": "<string>",
  "primaryContactLastName": "<string>",
  "primaryContactPhone": "<string>",
  "primaryContactEmail": "jsmith@example.com",
  "primaryContactIsAssociate": true,
  "formationDate": "<string>",
  "phone": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "stateProvinceRegion": "<string>",
  "postalCode": "<string>",
  "addressCountryId": "<string>",
  "expectedMonthlyPaymentsUsd": "<string>",
  "taxIdentificationNumber": "<string>",
  "operatesInProhibitedCountries": true,
  "highRiskActivities": [],
  "transmitsCustomerFunds": true,
  "customerFundsDescription": "<string>",
  "conductsMoneyServices": true,
  "primaryPurposeOther": "<string>",
  "ownershipTrustsFundsOrHoldingCompanies": true,
  "ownershipBranchesOrSubsidiaries": true,
  "ownershipBranchesOrSubsidiariesDetails": "<string>",
  "businessModelDescription": "<string>",
  "productServiceCatalogueWithPrices": true,
  "mainCustomers": "<string>",
  "mainSuppliers": "<string>",
  "completeFlowOfFunds": "<string>",
  "significantCashVolumes": true,
  "holdsClientBalances": true,
  "receivesUnrelatedThirdPartyPayments": true,
  "primaryOperatingCurrency": "<string>",
  "fxConversion": true,
  "fxConversionDescription": "<string>",
  "countriesWhereOperatesOrCustomers": "<string>",
  "averageTransactionAmountUsd": "<string>",
  "geographicDistribution": "<string>",
  "registeredPaidInCapitalUsd": "<string>",
  "lastFinancialStatementsClosingDate": "<string>",
  "lastFinancialStatementsAudited": true,
  "virtualAccountPurpose": [],
  "virtualAccountPurposeOther": "<string>",
  "virtualAccountUseContext": "<string>",
  "regulatedInAnyJurisdiction": true,
  "regulatedJurisdictionDetails": "<string>",
  "priorSanctionsInvestigations": true,
  "priorSanctionsInvestigationsDetails": "<string>",
  "bankingPspRelationships": "<string>",
  "pepDeclarationDetails": "<string>",
  "pepAttestationSignerName": "<string>",
  "pepAttestationDocumentNumber": "<string>",
  "pepAttestationSignerTitle": "<string>",
  "pepAttestationCompanyName": "<string>",
  "pepDeclarationAttested": true,
  "currentStep": 4,
  "documentIds": [
    "<string>"
  ],
  "persons": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "roles": [],
      "nationality": "<string>",
      "dateOfBirth": "2023-12-25",
      "documentIds": [
        "<string>"
      ],
      "ownershipPercent": 50,
      "email": "jsmith@example.com",
      "phone": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "stateProvinceRegion": "<string>",
      "postalCode": "<string>",
      "addressCountryId": "<string>",
      "taxIdentificationNumber": "<string>",
      "taxResidenceCountryId": "<string>",
      "businessTitle": "<string>",
      "relationshipEstablishedAt": "<string>",
      "idNumber": "<string>",
      "id": "<string>"
    }
  ],
  "legalEntityShareholders": [
    {
      "id": "<string>",
      "companyLegalName": "<string>",
      "registrationNumber": "<string>",
      "countryOfIncorporationId": "<string>",
      "roles": [],
      "ownershipPercent": 50,
      "documentIds": [
        "<string>"
      ]
    }
  ]
}
'
{
  "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

Body

application/json
​
id
string
required
​
companyName
string
Required string length: 1 - 200
​
registrationNumber
string
Required string length: 1 - 100
​
countryOfIncorporationId
string
Minimum string length: 1
​
tradingNames
string
​
businessIndustryId
string
Minimum string length: 1
​
website
​
operationalChannels
string
​
businessEmail
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
primaryContactFirstName
string
​
primaryContactLastName
string
​
primaryContactPhone
string
​
primaryContactEmail
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
primaryContactIsAssociate
boolean
​
businessType
enum<string>
Available options:
COOPERATIVE,
S_CORPORATION,
B_CORPORATION,
C_CORPORATION,
CLOSE_CORPORATION,
NONPROFIT_CORPORATION,
GENERAL_PARTNERSHIP,
LIMITED_PARTNERSHIP,
LIMITED_LIABILITY_COMPANY,
SOLE_PROPRIETORSHIP,
TRUST,
OTHER
​
formationDate
string
​
phone
string
​
addressLine1
string
​
addressLine2
string
​
city
string
​
stateProvinceRegion
string
​
postalCode
string
​
addressCountryId
string
​
estimatedAnnualRevenueUsd
enum<string>
Available options:
R_0_99999,
R_100000_999999,
R_1000000_9999999,
R_10000000_49999999,
R_50000000_249999999,
R_250000000_PLUS
​
expectedMonthlyPaymentsUsd
string
​
primaryBusinessPurpose
enum<string>
Available options:
CHARITABLE_DONATIONS,
ECOMMERCE_RETAIL_PAYMENTS,
INVESTMENT_PURPOSES,
OTHER,
PAYMENTS_TO_FRIENDS_OR_FAMILY_ABROAD,
PAYROLL,
PERSONAL_OR_LIVING_EXPENSES,
PROTECT_WEALTH,
PURCHASE_GOODS_AND_SERVICES,
RECEIVE_PAYMENTS_FOR_GOODS_AND_SERVICES,
TAX_OPTIMIZATION,
THIRD_PARTY_MONEY_TRANSMISSION,
TREASURY_MANAGEMENT
​
sourceOfFunds
enum<string>
Available options:
BUSINESS_LOANS,
GRANTS,
INTER_COMPANY_FUNDS,
INVESTMENT_PROCEEDS,
LEGAL_SETTLEMENT,
OWNERS_CAPITAL,
PENSION_RETIREMENT,
SALE_OF_ASSETS,
SALE_OF_ASSETS_REAL_ESTATE,
SALES_OF_GOODS_AND_SERVICES,
SAVINGS,
TAX_REFUND,
THIRD_PARTY_FUNDS,
TREASURY_RESERVES
​
taxIdType
enum<string>
Available options:
EIN,
SSN,
VAT,
TIN,
UTR
​
taxIdentificationNumber
string
​
operatesInProhibitedCountries
boolean
​
highRiskActivities
enum<string>[]
Available options:
NONE_OF_THE_ABOVE,
ADULT_ENTERTAINMENT,
GAMBLING,
HOLD_CLIENT_FUNDS,
INVESTMENT_SERVICES,
LENDING_BANKING,
MARIJUANA,
PRECIOUS_METALS_STONES,
WEAPONS_FIREARMS
​
transmitsCustomerFunds
boolean
​
customerFundsDescription
string
​
conductsMoneyServices
boolean
​
primaryPurposeOther
string
​
ownershipIndirectOrOffshoreStructures
enum<string>
Available options:
YES,
NO,
PARTIALLY
​
ownershipTrustsFundsOrHoldingCompanies
boolean
​
ownershipBranchesOrSubsidiaries
boolean
​
ownershipBranchesOrSubsidiariesDetails
string
​
businessModelDescription
string
​
customerType
enum<string>
Available options:
B2C,
B2B,
BOTH
​
invoiceIssuance
enum<string>
Available options:
YES_ALWAYS,
SOMETIMES,
NO
​
productServiceCatalogueWithPrices
boolean
​
mainCustomers
string
​
mainSuppliers
string
​
completeFlowOfFunds
string
​
significantCashVolumes
boolean
​
holdsClientBalances
boolean
​
receivesUnrelatedThirdPartyPayments
boolean
​
primaryOperatingCurrency
string
​
fxConversion
boolean
​
fxConversionDescription
string
​
endCustomersIdentified
enum<string>
Available options:
ALWAYS,
MOST_CASES,
NOT_NECESSARILY
​
countriesWhereOperatesOrCustomers
string
​
averageTransactionAmountUsd
string
​
geographicDistribution
string
​
registeredPaidInCapitalUsd
string
​
lastFinancialStatementsClosingDate
string
​
lastFinancialStatementsAudited
boolean
​
virtualAccountPurpose
enum<string>[]
Available options:
COLLECT_CUSTOMER_PAYMENTS,
PAY_SUPPLIERS,
TREASURY,
FX_SETTLEMENT,
MARKETPLACE_SETTLEMENT,
OTHER
​
virtualAccountPurposeOther
string
​
virtualAccountBalanceUsage
enum<string>
Available options:
HOLD_BALANCES,
PASS_THROUGH_ONLY,
BOTH
​
virtualAccountUseContext
string
​
fatfHighRiskExposure
enum<string>
Available options:
YES,
NO,
UNKNOWN
​
sanctionsExposure
enum<string>
Available options:
YES,
NO,
PERIODIC_SCREENING
​
regulatedInAnyJurisdiction
boolean
​
regulatedJurisdictionDetails
string
​
amlCftObligatedEntity
enum<string>
Available options:
YES,
NO,
NOT_APPLICABLE
​
formalAmlCftProgramme
enum<string>
Available options:
DOCUMENTED,
UNDER_DEVELOPMENT,
NO
​
priorSanctionsInvestigations
boolean
​
priorSanctionsInvestigationsDetails
string
​
bankingPspRelationships
string
​
pepDeclarationStatus
enum<string>
Available options:
NO_PEP,
HAS_PEP
​
pepDeclarationDetails
string
​
pepAttestationSignerName
string
​
pepAttestationDocumentNumber
string
​
pepAttestationSignerTitle
string
​
pepAttestationCompanyName
string
​
pepDeclarationAttested
boolean
​
currentStep
integer
Required range: 1 <= x <= 8
​
documentIds
string[]
​
persons
object[]
​
legalEntityShareholders
object[]

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[]
​
legalEntityShareholders
object[]