Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Create a customer

Create corporate customer

This operation will create a corporate customer.

Important
If you are using Enfuce as your BIN sponsor (under ELS or EUK licensing), you are required to populate certain fields when creating a corporate customer, even if the field is not marked as mandatory in this API specification. This is due to regulatory requirements related to Anti-Money Laundering (AML) and mandatory authority reporting.

The required fields for corporate customers include: name, regNo, registrationDate, registration.authority, address fields (address1, city, country, zipCode) and riskScore.

post/v3/CORPORATE

Query parameters

auditUserstring required

The audit user to log the request

Request body

emailstring
phoneNumberstring

Land line phone number to customer, must be full number including country code and starting with +

mobileNumberstring

Mobile number to customer, must be full number including country code and starting with +

customerNumberstring required

Can contain both letters and numbers. Max character limit is 64

locale'af_ZA' | 'ar_AE' | 'ar_BH' | 'ar_DZ' | 'ar_EG' | 'ar_IQ' | 'ar_JO' | 'ar_KW' | 'ar_LB' | 'ar_LY' | 'ar_MA' | 'ar_OM' | 'ar_QA' | 'ar_SA' | 'ar_SY' | 'ar_TN' | 'ar_YE' | 'az_AZ' | 'be_BY' | 'bg_BG' | 'bn_IN' | 'bs_BA' | 'ca_ES' | 'cs_CZ' | 'cy_GB' | 'da_DK' | 'de_AT' | 'de_CH' | 'de_DE' | 'de_LI' | 'de_LU' | 'de_NL' | 'el_GR' | 'en_AU' | 'en_BZ' | 'en_CA' | 'en_GB' | 'en_IE' | 'en_JM' | 'en_MT' | 'en_NZ' | 'en_PH' | 'en_TT' | 'en_US' | 'en_VI' | 'en_ZA' | 'en_ZW' | 'es_AR' | 'es_BO' | 'es_CL' | 'es_CO' | 'es_CR' | 'es_DO' | 'es_EC' | 'es_ES' | 'es_GT' | 'es_HN' | 'es_MX' | 'es_NI' | 'es_PA' | 'es_PE' | 'es_PR' | 'es_PY' | 'es_SV' | 'es_UY' | 'es_VE' | 'et_EE' | 'eu_ES' | 'fa_IR' | 'fi_FI' | 'fo_FO' | 'fr_BE' | 'fr_CA' | 'fr_CH' | 'fr_FR' | 'fr_LU' | 'fr_MC' | 'fr_NL' | 'ga_IE' | 'gl_ES' | 'gu_IN' | 'he_IL' | 'hi_IN' | 'hr_HR' | 'hu_HU' | 'hy_AM' | 'id_ID' | 'is_IS' | 'it_CH' | 'it_IT' | 'ja_JP' | 'ka_GE' | 'kk_KZ' | 'kl_GL' | 'kn_IN' | 'ko_KR' | 'kok_IN' | 'lb_LU' | 'lt_LT' | 'lv_LV' | 'mk_MK' | 'ml_IN' | 'mn_MN' | 'mr_IN' | 'ms_BN' | 'ms_MY' | 'mt_MT' | 'nb_NO' | 'nl_BE' | 'nl_NL' | 'nn_NO' | 'no_NO' | 'pa_IN' | 'pl_PL' | 'pt_BR' | 'pt_PT' | 'ro_RO' | 'ru_RU' | 'se_NO' | 'sk_SK' | 'sl_SI' | 'sq_AL' | 'sr_BA' | 'sr_CS' | 'sv_FI' | 'sv_SE' | 'sw_KE' | 'syr_SY' | 'ta_IN' | 'te_IN' | 'th_TH' | 'tn_ZA' | 'tr_TR' | 'uk_UA' | 'uz_UZ' | 'vi_VN' | 'xh_ZA' | 'zh_CN' | 'zh_HK' | 'zh_MO' | 'zh_SG' | 'zh_TW' | 'zu_ZA' required

Customer's language and country code, these are the valid locales in API

regNostring required

Identifier to customer, for example SSN. Enfuce does not do any validation for this regNo

namestring required

Human readable name of an account

customerRepresentativestring

Field value is printed to outgoing invoices. In order to use this field it should be agreed in advantage with selected printing partner how it's represented on the invoice.

riskScore'High' | 'Med' | 'Low' | 'Pep' | 'Prohibited'

Risk assessment score of the customer. Can be one of the following values:

  • High: High-risk customer
  • Med: Medium-risk customer
  • Low: Low-risk customer
  • Pep: Politically Exposed Person (PEP)
  • Prohibited: Customer sanctioned or outside of risk appetite

Example request

{
  "email": "info@enfuce.com",
  "phoneNumber": "+35821010001",
  "mobileNumber": "+358401234567",
  "customerNumber": "ABCDEFGH123456789",
  "regNo": "19560606-1234",
  "screening": {
    "status": true,
    "statusLastUpdated": "2025-01-28"
  },
  "address": {
    "address1": "Kings street 12",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands"
  },
  "temporaryAddress": {
    "address1": "Kings street 12",
    "city": "Mariehamn",
    "country": "FIN",
    "region": "Åland Islands"
  },
  "name": "My example account name",
  "customerRepresentative": "Mrs Smith",
  "registration": {
    "authority": "Patent and Registration Office",
    "registrationDate": "2023-05-03"
  },
  "riskScore": "Med"
}

Response

Successful creation of customer

descriptionstring

Short description of the result of the action

idstring

Will contain the ID of the resource that has been created or updated