> ## Documentation Index > Fetch the complete documentation index at: https://docs.nuvera.global/llms.txt > Use this file to discover all available pages before exploring further. # Create a customer > Create a new customer with company info, persons, and documents. Submits for review. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/customers openapi: 3.1.0 info: title: Nuvera API description: Nuvera Payment Platform REST API version: '1.0' contact: {} servers: - url: http://localhost:45000 security: [] tags: [] paths: /api/v1/customers: post: tags: - Customers summary: Create a customer description: >- Create a new customer with company info, persons, and documents. Submits for review. operationId: CustomerController_create parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCustomerDto' responses: default: description: '' content: application/json: schema: $ref: '#/components/schemas/CustomerOutputDto_Output' security: - x-api-key: [] signed-request: [] components: schemas: CreateCustomerDto: type: object properties: companyName: type: string minLength: 1 maxLength: 200 description: Registered company name registrationNumber: type: string minLength: 1 maxLength: 100 description: Company registration number countryOfIncorporationId: type: string minLength: 1 description: Country of incorporation ID tradingNames: description: Trading names (comma-separated) type: string businessIndustryId: type: string minLength: 1 description: Primary business industry ID website: anyOf: - type: string format: uri - type: string const: '' description: Company website operationalChannels: description: Operational and sales channels type: string businessEmail: anyOf: - type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ - type: string const: '' description: Business email address primaryContactFirstName: description: Primary contact first name type: string primaryContactLastName: description: Primary contact last name type: string primaryContactPhone: description: Primary contact phone number type: string primaryContactEmail: anyOf: - type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ - type: string const: '' description: Primary contact email primaryContactIsAssociate: description: Primary contact also needs associate details type: boolean businessType: description: Business type type: string enum: - COOPERATIVE - S_CORPORATION - B_CORPORATION - C_CORPORATION - CLOSE_CORPORATION - NONPROFIT_CORPORATION - GENERAL_PARTNERSHIP - LIMITED_PARTNERSHIP - LIMITED_LIABILITY_COMPANY - SOLE_PROPRIETORSHIP - TRUST - OTHER formationDate: description: Formation date type: string phone: description: Company phone number type: string addressLine1: description: Address line 1 type: string addressLine2: description: Address line 2 type: string city: description: City type: string stateProvinceRegion: description: State/Province/Region type: string postalCode: description: Postal code type: string addressCountryId: description: Address country ID type: string estimatedAnnualRevenueUsd: description: Estimated annual revenue in USD type: string enum: - R_0_99999 - R_100000_999999 - R_1000000_9999999 - R_10000000_49999999 - R_50000000_249999999 - R_250000000_PLUS expectedMonthlyPaymentsUsd: description: Expected monthly payments in USD type: string primaryBusinessPurpose: description: Primary business purpose type: string enum: - 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: description: Source of funds type: string enum: - 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: description: Tax ID type type: string enum: - EIN - SSN - VAT - TIN - UTR taxIdentificationNumber: description: Tax identification number type: string operatesInProhibitedCountries: description: Operates in prohibited countries type: boolean highRiskActivities: description: High risk activities type: array items: type: string enum: - NONE_OF_THE_ABOVE - ADULT_ENTERTAINMENT - GAMBLING - HOLD_CLIENT_FUNDS - INVESTMENT_SERVICES - LENDING_BANKING - MARIJUANA - PRECIOUS_METALS_STONES - WEAPONS_FIREARMS transmitsCustomerFunds: description: Transmits customer funds type: boolean customerFundsDescription: description: Customer funds description type: string conductsMoneyServices: description: Conducts money services type: boolean primaryPurposeOther: description: Primary purpose other description type: string ownershipIndirectOrOffshoreStructures: description: Indirect shareholders or offshore structures disclosure type: string enum: - 'YES' - 'NO' - PARTIALLY ownershipTrustsFundsOrHoldingCompanies: description: Trusts, funds, or holding companies in ownership structure type: boolean ownershipBranchesOrSubsidiaries: description: Branches or subsidiaries in other countries type: boolean ownershipBranchesOrSubsidiariesDetails: description: Countries and entity types for branches or subsidiaries type: string businessModelDescription: description: Business model description type: string customerType: description: Customer type type: string enum: - B2C - B2B - BOTH invoiceIssuance: description: Invoice issuance type: string enum: - YES_ALWAYS - SOMETIMES - 'NO' productServiceCatalogueWithPrices: description: Product/service catalogue with prices available type: boolean mainCustomers: description: Main customers type: string mainSuppliers: description: Main suppliers type: string completeFlowOfFunds: description: Complete flow of funds type: string significantCashVolumes: description: Significant cash volumes type: boolean holdsClientBalances: description: Holds client balances type: boolean receivesUnrelatedThirdPartyPayments: description: Receives payments from unrelated third parties type: boolean primaryOperatingCurrency: description: Primary operating currency type: string fxConversion: description: Uses FX conversion type: boolean fxConversionDescription: description: FX conversion description type: string endCustomersIdentified: description: End customer identification type: string enum: - ALWAYS - MOST_CASES - NOT_NECESSARILY countriesWhereOperatesOrCustomers: description: Countries where the company operates or has customers type: string averageTransactionAmountUsd: description: Average transaction amount in USD type: string geographicDistribution: description: Geographic distribution percentages type: string registeredPaidInCapitalUsd: description: Registered or paid-in capital in USD type: string lastFinancialStatementsClosingDate: description: Last financial statements closing date type: string lastFinancialStatementsAudited: description: Last financial statements audited type: boolean virtualAccountPurpose: description: Primary purpose of virtual account type: array items: type: string enum: - COLLECT_CUSTOMER_PAYMENTS - PAY_SUPPLIERS - TREASURY - FX_SETTLEMENT - MARKETPLACE_SETTLEMENT - OTHER virtualAccountPurposeOther: description: Other virtual account purpose type: string virtualAccountBalanceUsage: description: Virtual account balance usage type: string enum: - HOLD_BALANCES - PASS_THROUGH_ONLY - BOTH virtualAccountUseContext: description: Additional virtual account use context type: string fatfHighRiskExposure: description: FATF high-risk exposure type: string enum: - 'YES' - 'NO' - UNKNOWN sanctionsExposure: description: Sanctions exposure type: string enum: - 'YES' - 'NO' - PERIODIC_SCREENING regulatedInAnyJurisdiction: description: Regulated in any jurisdiction type: boolean regulatedJurisdictionDetails: description: Regulated jurisdiction details type: string amlCftObligatedEntity: description: AML/CFT obligated entity status type: string enum: - 'YES' - 'NO' - NOT_APPLICABLE formalAmlCftProgramme: description: Formal AML/CFT programme type: string enum: - DOCUMENTED - UNDER_DEVELOPMENT - 'NO' priorSanctionsInvestigations: description: Prior sanctions or investigations type: boolean priorSanctionsInvestigationsDetails: description: Prior sanctions or investigations details type: string bankingPspRelationships: description: Banking or PSP relationships type: string pepDeclarationStatus: description: PEP declaration status type: string enum: - NO_PEP - HAS_PEP pepDeclarationDetails: description: PEP declaration details type: string pepAttestationSignerName: description: PEP attestation signer name type: string pepAttestationDocumentNumber: description: PEP attestation document number type: string pepAttestationSignerTitle: description: PEP attestation signer title type: string pepAttestationCompanyName: description: PEP attestation company name type: string pepDeclarationAttested: description: PEP declaration attestation type: boolean currentStep: description: Current onboarding step type: integer minimum: 1 maximum: 8 documentIds: type: array items: type: string description: IDs of uploaded company documents persons: type: array items: type: object properties: firstName: type: string minLength: 1 description: First name lastName: type: string minLength: 1 description: Last name roles: minItems: 1 type: array items: type: string enum: - SHAREHOLDER - UBO - DIRECTOR - OWNER_OR_OPERATOR - PARTNER - AGENT_OR_AUTHORISED_PERSON description: Roles held by this person ownershipPercent: description: >- Ownership percentage (optional for directors with no ownership) type: number minimum: 0 maximum: 100 nationality: type: string minLength: 1 description: Nationality dateOfBirth: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ description: Date of birth (YYYY-MM-DD) documentIds: type: array items: type: string description: >- IDs of uploaded KYC documents (ID front, ID back, proof of address) email: description: Email address type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ phone: description: Phone number type: string addressLine1: description: Address line 1 type: string addressLine2: description: Address line 2 type: string city: description: City type: string stateProvinceRegion: description: State/Province/Region type: string postalCode: description: Postal code type: string addressCountryId: description: Address country ID type: string taxIdentificationNumber: description: Tax identification number type: string taxResidenceCountryId: description: Country of tax residence type: string businessTitle: description: Business title type: string relationshipEstablishedAt: description: Date relationship was established type: string idNumber: description: ID number type: string required: - firstName - lastName - roles - nationality - dateOfBirth - documentIds description: UBOs, shareholders, and directors holding >25% legalEntityShareholders: default: [] description: Legal entity shareholders and partners type: array items: type: object properties: companyLegalName: type: string minLength: 1 description: Company legal name registrationNumber: type: string minLength: 1 description: Registration number countryOfIncorporationId: type: string minLength: 1 description: Country of incorporation entityType: type: string enum: - HOLDING - FUND - TRUST - OPERATING_COMPANY - OTHER description: Legal entity type roles: minItems: 1 type: array items: type: string enum: - SHAREHOLDER - PARTNER description: Legal entity roles ownershipPercent: type: number minimum: 0 maximum: 100 documentIds: type: array items: type: string description: IDs of uploaded legal entity shareholder documents required: - companyLegalName - registrationNumber - countryOfIncorporationId - entityType - roles - ownershipPercent - documentIds isDraft: default: false description: Save as draft without submitting for review type: boolean required: - companyName - registrationNumber - countryOfIncorporationId - businessIndustryId - documentIds - persons CustomerOutputDto_Output: type: object properties: id: type: string orgId: type: string companyName: type: string registrationNumber: type: string countryOfIncorporationId: anyOf: - type: string - type: 'null' countryOfIncorporation: anyOf: - type: object properties: alpha2: type: string name: type: string required: - alpha2 - name additionalProperties: false - type: 'null' tradingNames: anyOf: - type: string - type: 'null' businessIndustryId: anyOf: - type: string - type: 'null' businessIndustry: anyOf: - type: object properties: code: type: string name: type: string required: - code - name additionalProperties: false - type: 'null' website: anyOf: - type: string - type: 'null' operationalChannels: anyOf: - type: string - type: 'null' businessEmail: anyOf: - type: string - type: 'null' primaryContactFirstName: anyOf: - type: string - type: 'null' primaryContactLastName: anyOf: - type: string - type: 'null' primaryContactPhone: anyOf: - type: string - type: 'null' primaryContactEmail: anyOf: - type: string - type: 'null' primaryContactIsAssociate: anyOf: - type: boolean - type: 'null' businessType: anyOf: - type: string - type: 'null' formationDate: anyOf: - type: string - type: 'null' phone: anyOf: - type: string - type: 'null' addressLine1: anyOf: - type: string - type: 'null' addressLine2: anyOf: - type: string - type: 'null' city: anyOf: - type: string - type: 'null' stateProvinceRegion: anyOf: - type: string - type: 'null' postalCode: anyOf: - type: string - type: 'null' addressCountryId: anyOf: - type: string - type: 'null' addressCountry: anyOf: - type: object properties: alpha2: type: string name: type: string required: - alpha2 - name additionalProperties: false - type: 'null' estimatedAnnualRevenueUsd: anyOf: - type: string - type: 'null' expectedMonthlyPaymentsUsd: type: string primaryBusinessPurpose: anyOf: - type: string - type: 'null' sourceOfFunds: anyOf: - type: string - type: 'null' taxIdType: anyOf: - type: string - type: 'null' taxIdentificationNumber: anyOf: - type: string - type: 'null' operatesInProhibitedCountries: anyOf: - type: boolean - type: 'null' highRiskActivities: anyOf: - type: array items: type: string - type: 'null' transmitsCustomerFunds: anyOf: - type: boolean - type: 'null' customerFundsDescription: anyOf: - type: string - type: 'null' conductsMoneyServices: anyOf: - type: boolean - type: 'null' primaryPurposeOther: anyOf: - type: string - type: 'null' ownershipIndirectOrOffshoreStructures: anyOf: - type: string - type: 'null' ownershipTrustsFundsOrHoldingCompanies: anyOf: - type: boolean - type: 'null' ownershipBranchesOrSubsidiaries: anyOf: - type: boolean - type: 'null' ownershipBranchesOrSubsidiariesDetails: anyOf: - type: string - type: 'null' businessModelDescription: anyOf: - type: string - type: 'null' customerType: anyOf: - type: string - type: 'null' invoiceIssuance: anyOf: - type: string - type: 'null' productServiceCatalogueWithPrices: anyOf: - type: boolean - type: 'null' mainCustomers: anyOf: - type: string - type: 'null' mainSuppliers: anyOf: - type: string - type: 'null' completeFlowOfFunds: anyOf: - type: string - type: 'null' significantCashVolumes: anyOf: - type: boolean - type: 'null' holdsClientBalances: anyOf: - type: boolean - type: 'null' receivesUnrelatedThirdPartyPayments: anyOf: - type: boolean - type: 'null' primaryOperatingCurrency: anyOf: - type: string - type: 'null' fxConversion: anyOf: - type: boolean - type: 'null' fxConversionDescription: anyOf: - type: string - type: 'null' endCustomersIdentified: anyOf: - type: string - type: 'null' countriesWhereOperatesOrCustomers: anyOf: - type: string - type: 'null' averageTransactionAmountUsd: anyOf: - type: string - type: 'null' geographicDistribution: anyOf: - type: string - type: 'null' registeredPaidInCapitalUsd: anyOf: - type: string - type: 'null' lastFinancialStatementsClosingDate: anyOf: - type: string - type: 'null' lastFinancialStatementsAudited: anyOf: - type: boolean - type: 'null' virtualAccountPurpose: anyOf: - type: array items: type: string - type: 'null' virtualAccountPurposeOther: anyOf: - type: string - type: 'null' virtualAccountBalanceUsage: anyOf: - type: string - type: 'null' virtualAccountUseContext: anyOf: - type: string - type: 'null' fatfHighRiskExposure: anyOf: - type: string - type: 'null' sanctionsExposure: anyOf: - type: string - type: 'null' regulatedInAnyJurisdiction: anyOf: - type: boolean - type: 'null' regulatedJurisdictionDetails: anyOf: - type: string - type: 'null' amlCftObligatedEntity: anyOf: - type: string - type: 'null' formalAmlCftProgramme: anyOf: - type: string - type: 'null' priorSanctionsInvestigations: anyOf: - type: boolean - type: 'null' priorSanctionsInvestigationsDetails: anyOf: - type: string - type: 'null' bankingPspRelationships: anyOf: - type: string - type: 'null' pepDeclarationStatus: anyOf: - type: string - type: 'null' pepDeclarationDetails: anyOf: - type: string - type: 'null' pepAttestationSignerName: anyOf: - type: string - type: 'null' pepAttestationDocumentNumber: anyOf: - type: string - type: 'null' pepAttestationSignerTitle: anyOf: - type: string - type: 'null' pepAttestationCompanyName: anyOf: - type: string - type: 'null' pepDeclarationAttested: anyOf: - type: boolean - type: 'null' status: type: string currentStep: type: number createdAt: type: string updatedAt: type: string beneficiaryCount: type: number paymentCount: type: number persons: type: array items: type: object properties: id: type: string customerId: type: string firstName: type: string lastName: type: string roles: type: array items: type: string ownershipPercent: anyOf: - type: number - type: 'null' nationalityId: anyOf: - type: string - type: 'null' dateOfBirth: type: string email: anyOf: - type: string - type: 'null' phone: anyOf: - type: string - type: 'null' addressLine1: anyOf: - type: string - type: 'null' addressLine2: anyOf: - type: string - type: 'null' city: anyOf: - type: string - type: 'null' stateProvinceRegion: anyOf: - type: string - type: 'null' postalCode: anyOf: - type: string - type: 'null' addressCountryId: anyOf: - type: string - type: 'null' taxIdentificationNumber: anyOf: - type: string - type: 'null' taxResidenceCountryId: anyOf: - type: string - type: 'null' businessTitle: anyOf: - type: string - type: 'null' relationshipEstablishedAt: anyOf: - type: string - type: 'null' idNumber: anyOf: - type: string - type: 'null' createdAt: type: string updatedAt: type: string required: - id - customerId - firstName - lastName - roles - ownershipPercent - nationalityId - dateOfBirth - email - phone - addressLine1 - addressLine2 - city - stateProvinceRegion - postalCode - addressCountryId - taxIdentificationNumber - taxResidenceCountryId - businessTitle - relationshipEstablishedAt - idNumber - createdAt - updatedAt additionalProperties: false legalEntityShareholders: type: array items: type: object properties: id: type: string customerId: type: string companyLegalName: type: string registrationNumber: type: string countryOfIncorporationId: type: string countryOfIncorporation: anyOf: - type: object properties: alpha2: type: string name: type: string required: - alpha2 - name additionalProperties: false - type: 'null' entityType: type: string roles: type: array items: type: string ownershipPercent: type: number createdAt: type: string updatedAt: type: string required: - id - customerId - companyLegalName - registrationNumber - countryOfIncorporationId - entityType - roles - ownershipPercent - createdAt - updatedAt additionalProperties: false required: - id - orgId - companyName - registrationNumber - countryOfIncorporationId - tradingNames - businessIndustryId - website - operationalChannels - businessEmail - primaryContactFirstName - primaryContactLastName - primaryContactPhone - primaryContactEmail - primaryContactIsAssociate - businessType - formationDate - phone - addressLine1 - addressLine2 - city - stateProvinceRegion - postalCode - addressCountryId - estimatedAnnualRevenueUsd - expectedMonthlyPaymentsUsd - primaryBusinessPurpose - sourceOfFunds - taxIdType - taxIdentificationNumber - operatesInProhibitedCountries - highRiskActivities - transmitsCustomerFunds - customerFundsDescription - conductsMoneyServices - primaryPurposeOther - ownershipIndirectOrOffshoreStructures - ownershipTrustsFundsOrHoldingCompanies - ownershipBranchesOrSubsidiaries - ownershipBranchesOrSubsidiariesDetails - businessModelDescription - customerType - invoiceIssuance - productServiceCatalogueWithPrices - mainCustomers - mainSuppliers - completeFlowOfFunds - significantCashVolumes - holdsClientBalances - receivesUnrelatedThirdPartyPayments - primaryOperatingCurrency - fxConversion - fxConversionDescription - endCustomersIdentified - countriesWhereOperatesOrCustomers - averageTransactionAmountUsd - geographicDistribution - registeredPaidInCapitalUsd - lastFinancialStatementsClosingDate - lastFinancialStatementsAudited - virtualAccountPurpose - virtualAccountPurposeOther - virtualAccountBalanceUsage - virtualAccountUseContext - fatfHighRiskExposure - sanctionsExposure - regulatedInAnyJurisdiction - regulatedJurisdictionDetails - amlCftObligatedEntity - formalAmlCftProgramme - priorSanctionsInvestigations - priorSanctionsInvestigationsDetails - bankingPspRelationships - pepDeclarationStatus - pepDeclarationDetails - pepAttestationSignerName - pepAttestationDocumentNumber - pepAttestationSignerTitle - pepAttestationCompanyName - pepDeclarationAttested - status - currentStep - createdAt - updatedAt additionalProperties: false securitySchemes: x-api-key: type: apiKey in: header name: x-api-key description: Nuvera API application secret key signed-request: scheme: bearer bearerFormat: JWT type: http description: RS256 per-request signed JWT ````