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

achCompanyID
string <= 10 characters

ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)

lei
string <= 20 characters

Legal Entity ID for accounting/tax purpose. Must be unique across all customers.

swiftCode
string <= 255 characters

SWIFT code

language
required
string <= 255 characters

Suported language

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

Customer Email Address

phoneNumber
string <= 255 characters

Customer's Phone number

faxNumber
string <= 255 characters

Customer's phone 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 (CustomerAddress)
mailAddressSameAsLegal
required
boolean
object (CustomerAddress)
relationshipType
string

Relationship 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
required
string <= 20 characters

Cost Center code

relationshipManager
required
string <= 255 characters

Relationship manager name. It needs to be a valid user login id in the system

originatingOfficer
required
string <= 255 characters

Originating Officer name. Its needs to be a valid user login id in the system

parentEntityShortName
string <= 255 characters

This is shortname of the parent org

object (CustomerAdditonalProfileDetails)
secCodes
Array of strings

Provide all valid SEC-Standard Entry Class codes allowed for the given customer entity. e.g. WEB,CCD,PPD,TEL,IAT, etc..

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

402

The parameters were valid but the request failed.

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

409

The request conflicts with another request (perhaps due to using the same idempotent key).

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

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",
  • "achCompanyID": "1234567899",
  • "lei": "ABC1234",
  • "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": {
    },
  • "secCodes": [
    ],
  • "note": "Note for the LE",
  • "legalEntityAccessSettings": {
    },
  • "additionalAttributes": [
    ]
}
Response samples
application/json
{
  • "status": "Success",
  • "code": "CUST001",
  • "message": "Failed to create a customer due to the mandatory attribute <attribute-name> is not provide.",
  • "data": {
    }
}