Add customer

Create a customer in the BankOS CRM system

SecurityoAuth2
Request
Request Body schema: application/json
required

Customer details

legalName
required
string <= 255 characters

Customer's legal name

shortName
required
string <= 255 characters

Customer's short name. Must be unique across all customers.

customerId
string

Customer Id, this is an optional field and if it is provided then it is unique.

customerType
required
string <= 45 characters

Type of customer

Enum: "Corporate" "Consumer" "Financial Institution" "Downstream Partner" "Processing Org"
taxId
required
string <= 10 characters

Tax ID

lei
string <= 20 characters ^[A-Z0-9]{4}00[A-Z0-9]{12}[0-9]{2}$

Legal Entity Identifier (LEI) used for accounting and tax purposes. This field is optional but must be unique across all customers if provided. The value must follow the ISO 17442 standard: a 20-character alphanumeric format.

swiftCode
string <= 255 characters

SWIFT code

language
string <= 255 characters

Supported language. Defaults to English if not provided.

Enum: "English" "Spanish"
emailAddress
string <= 255 characters

Customer Email Address

phoneNumber
string <= 255 characters

Customer's Phone number

faxNumber
string <= 255 characters

Customer's fax number

webSite
string <= 255 characters

Customer's website

logoUrl
string <= 255 characters

Customer's logo url

linkedinUrl
string <= 255 characters

Customer's LinkedIn profile URL

twitterUrl
string <= 255 characters

Customer's twitter url

required
object

The following fields are required: addressLine1, city, and postalCode.

mailAddressSameAsLegal
boolean

Indicates whether the mailing address is the same as the legal address. Defaults to true.

object

Only required when mailAddressSameAsLegal is false. If provided, the following fields are required: addressLine1, city, and postalCode.

relationshipType
string

Optional field. This will be auto-populated based on the customer type.

Enum: "customer" "bank" "thirdparty" "self"
partnerOrgShortName
string <= 255 characters

This is shortname of the partner org. This is required if the relationshipType is Third Party optional otherwise.

costCenter
string <= 20 characters

Cost Center code is an optional field. If it is not provided, the default cost center will be taken from the relation.

relationshipManager
string <= 255 characters

Relationship manager login ID. Must be a valid user login ID in the system. Optional when partnerOrgShortName is provided.

originatingOfficer
string <= 255 characters

Originating officer login ID. Must be a valid user login ID in the system. Optional when partnerOrgShortName is provided.

parentEntityShortName
string <= 255 characters

This is shortname of the parent org

object (CustomerAdditonalProfileDetails)
note
string <= 255 characters

notes

object (LegalEntityAccessSettings)
Array of objects (AdditionalAttribute)

List of additional customer attributes configured in the system.

Responses
200

Successfully processed request

400

bad input parameter environment

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

405

bad input parameter environment

500

Something went wrong on back end.

503

Service unavailable

default

Customer details with newly created ID

post/v2/customers
Request samples
application/json
{
  • "legalName": "ABC Bank",
  • "shortName": "BOFA",
  • "customerId": "CUST123",
  • "customerType": "Corporate",
  • "taxId": "123456789",
  • "lei": "5493001KJTIIGC8Y1R12",
  • "swiftCode": "BOFAUS3N",
  • "language": "English",
  • "emailAddress": "abc@abc.com",
  • "phoneNumber": "123-124-9877",
  • "faxNumber": "123-124-9877",
  • "webSite": "http://www.finzly.com",
  • "logoUrl": "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_92x30dp.png",
  • "linkedinUrl": "https://www.linkedin.com/company/finzly",
  • "twitterUrl": "https://twitter.com/finzly",
  • "legalAddress": {
    },
  • "mailAddressSameAsLegal": true,
  • "mailingAddress": {
    },
  • "relationshipType": "Customer",
  • "partnerOrgShortName": "ABC",
  • "costCenter": "123123121",
  • "relationshipManager": "testuser",
  • "originatingOfficer": "testuser",
  • "parentEntityShortName": "ParentEntity",
  • "additionalProfileDetails": {
    },
  • "note": "Note for the LE",
  • "legalEntityAccessSettings": {
    },
  • "additionalAttributes": [
    ]
}
Response samples
application/json
{
  • "status": "Success",
  • "code": "string",
  • "message": "string",
  • "data": {
    }
}