Corporate Client Registration API

post

https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/client/corporateClientRegistration

This API is used for the registration of the prepaid corporate client.

HTTP Status and Response Status Matrix

HTTP Code: This is the response status code issued by a server in response to a client's request made to the server.
Error Code: This is the error code returned by Credit+ Issuing application in the ‘code’ field of the response message indicating if the request was processed successfully or failed.
Reason: This is the description of the error code returned by Credit+ Issuing application.

HTTP Code	Error Code	Reason
201	000	SUCCESS.
400	900	User Or Bank does not support API.
400	995	Duplicate Corporate Client ID Received.
400	997	Validation Error messages.
400	998	API request not as per defined format - Invalid Request Type.
400	999	API Not allowed for Institution.
403	900	User Or Bank does not support API.
400	911	Corporate ID field is mandatory for this bank.
400	997	companyName field is mandatory.
400	997	embossLine4 field is mandatory.
400	997	branchCode field is mandatory.
400	997	preferredMailingAddress field is mandatory.
400	997	preferredEmail field is mandatory.
400	997	officeAddress1 field is mandatory.
400	997	officeCountry field is mandatory.
400	997	officeZipCode field is mandatory.
400	997	officeEmailID field is mandatory.
400	997	currentAddress1 field is mandatory.
400	997	currentCountry field is mandatory.
400	997	currentZipCode field is mandatory.
400	997	currentEmailID field is mandatory.
400	997	applicationRefNumber field value must have max length 14.
400	997	corporateID field value must have max length 24.
400	997	companyName field value must have max length 100.
400	997	embossLine4 field value must have max length 26.
400	997	branchCode field value must have max length 6.
400	997	program field value must have max length 6.
400	997	isMobileUpdateAllowed field value must have max length 1.
400	997	isEmailUpdateAllowed field value must have max length 1.
400	997	preferredMailingAddress field value must have max length 1.
400	997	preferredEmail field value must have max length 1.
400	997	officeAddress1 field value must have max length 300.
400	997	officeAddress2 field value must have max length 300.
400	997	officeAddress3 field value must have max length 300.
400	997	officeAddress4 field value must have max length 300.
400	997	officeCountry field value must have max length 3.
400	997	officeState field value must have max length 50.
400	997	officeCity field value must have max length 50.
400	997	officeZipCode field value must have max length 10.
400	997	officeContactNo1 field value must have max length 80.
400	997	officeContactNo2 field value must have max length 80.
400	997	officeExt field value must have max length 5.
400	997	officeEmailID field value must have max length 50.
400	997	officeFaxNo field value must have max length 80.
400	997	currentAddress1 field value must have max length 300.
400	997	currentAddress2 field value must have max length 300.
400	997	currentAddress3 field value must have max length 300.
400	997	currentAddress4 field value must have max length 300.
400	997	currentCountry field value must have max length 3.
400	997	currentState field value must have max length 50.
400	997	currentCity field value must have max length 50.
400	997	currentZipCode field value must have max length 10.
400	997	currentContactNo1 field value must have max length 80.
400	997	currentContactNo2 field value must have max length 80.
400	997	currentISDCode field value must have max length 4.
400	997	currentMobNo field value must have max length 15.
400	997	currentEmailID field value must have max length 60.
400	997	currentTenure field value must have max length 4.
400	997	permanentAddress1 field value must have max length 300.
400	997	permanentAddress2 field value must have max length 300.
400	997	permanentAddress3 field value must have max length 300.
400	997	permanentAddress4 field value must have max length 300.
400	997	permanentCountry field value must have max length 3.
400	997	permanentState field value must have max length 50.
400	997	permanentCity field value must have max length 50.
400	997	permanentZipCode field value must have max length 10.
400	997	permanentContactNo1 field value must have max length 80.
400	997	permanentContactNo2 field value must have max length 80.
400	997	referenceAddressLine1 field value must have max length 50.
400	997	referenceAddressLine2 field value must have max length 50.
400	997	referenceAddressLine3 field value must have max length 50.
400	997	referenceAddressLine4 field value must have max length 50.
400	997	referenceCityCode field value must have max length 50.
400	997	referenceCountryCode field value must have max length 3.
400	997	referenceStateCode field value must have max length 50.
400	997	referenceZIPCode field value must have max length 10.
400	997	referencePhoneNumber field value must have max length 80.
400	997	legalIDtanNo field value must have max length 10.
400	997	itWardDistNo field value must have max length 15.
400	997	tenureOfAccountInYears field value must have max length 4.
400	997	tenureOfAccountInMonths field value must have max length 4.
400	997	numberOfEmployees field value must have max length 10.
400	997	parentCompanyName field value must have max length 30.
400	997	parentCompanyAddress1 field value must have max length 300.
400	997	parentCompanyAddress2 field value must have max length 300.
400	997	parentCompanyAddress3 field value must have max length 300.
400	997	parentCompanyAddress4 field value must have max length 300.
400	997	parentCompanyCountry field value must have max length 3.
400	997	parentCompanyState field value must have max length 50.
400	997	parentCompanyCity field value must have max length 50.
400	997	parentCompanyZipCode field value must have max length 10.
400	997	bankName field value must have max length 50.
400	997	accountNumber field value must have max length 20.
400	997	bankContactNumber field value must have max length 80.
400	997	bankContactPerson field value must have max length 40.
400	997	bankAddress1 field value must have max length 300.
400	997	bankAddress2 field value must have max length 300.
400	997	bankAddress3 field value must have max length 300.
400	997	bankAddress4 field value must have max length 300.
400	997	bankCountry field value must have max length 3.
400	997	bankState field value must have max length 50.
400	997	bankCity field value must have max length 50.
400	997	bankZipCode field value must have max length 10.
400	997	modeOfPayment field value must have max length 1.
400	997	debitBankAccountNo field value must have max length 20.
400	997	authSignFirstName field value must have max length 20.
400	997	authSignMiddleName1 field value must have max length 20.
400	997	authSignMiddleName2 field value must have max length 20.
400	997	authSignLastName field value must have max length 20.
400	997	authSignDesignation field value must have max length 20.
400	997	authSignContactNo1 field value must have max length 20.
400	997	authSignContactNo2 field value must have max length 20.
400	997	authSignEmpNo field value must have max length 20.
400	997	authSignEmailId field value must have max length 50.
400	997	numberOfEmployees field must be a whole number.
400	997	paidUpCapital field must be a positive value with maximum 12 integers and 7 fractions.
400	997	annualSales field must be a positive value with maximum 12 integers and 7 fractions.
400	997	netSales field must be a positive value with maximum 12 integers and 7 fractions.
400	997	incorporationDate field must be in dd/MM/yyyy format.
400	997	estimatedAnnualSpendOnCards field must be a positive value with maximum 12 integers and 7 fractions.
500	999	Error while mapping program to corporate client.
500	999	Error while retrieving data from system codes.
400	997	Invalid institution.
500	999	Error while retrieving data from institution.
400	997	Invalid branch code.
500	999	Error while retrieving data from branch.
400	997	Invalid program.
400	997	Error while retrieving data from program.
400	997	Invalid officeCountry.
400	997	Invalid currentCountry.
400	997	Invalid permanentCountry.
400	997	Invalid referenceCountryCode.
400	997	Invalid parentCompanyCountry.
400	997	Invalid bankCountry.
400	997	Error while validating zip code.
500	999	Error while retrieving data from system codes center.
400	997	Invalid constitution.
400	997	Invalid industry.
400	997	Invalid businessType.
500	999	Error while creating corporate client code.
201	996	Duplicate Corporate Client ID received.
400	997	Error while retrieving data from corporate client.
400	997	Error while inserting in corporate client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

applicationRefNumber

string

length ≤ 14

^[0-9]*$

This is mandatory based on configuration for an institution. Number. Length: 14. Example: ''

corporateID

string

length ≤ 24

^[a-zA-Z0-9]*$

If this field is mandatory, the system validates the uniqueness of the Corporate ID. If a request contains a Corporate ID which is already present in Credit+ Issuing system then API is rejected. Alphanumeric. Length: 24. Example: ''

companyName

string

required

length ≤ 100

^[a-zA-Z0-9 ]+$

Alphanumeric. Length: 100. Example: PineLabs

embossLine4

string

length ≤ 26

^[a-zA-Z ]*$

Alphanumeric. Length: 26. Example: PineLabs

branchCode

string

required

length ≤ 6

^[a-zA-Z0-9]+$

This should be a valid Branch Code defined in Credit+ Issuing. Alphanumeric. Length: 6. Example: 1925

program

string

length ≤ 6

^[A-Z0-9][A-Z0-9_]*[A-Z0-9]$|^$

This should be a valid Prepaid Program defined in Credit+ Issuing. Alphanumeric. Length: 6. Example: ''

isMobileUpdateAllowed

string

enum

length ≤ 1

Alphanumeric. Length: 1. Valid Values - Y / N. Example: ''

Allowed:

isEmailUpdateAllowed

string

enum

length ≤ 1

Alphanumeric. Length: 1. Valid Values - Y / N. Example: ''

Allowed:

preferredMailingAddress

string

enum

required

length ≤ 1

C-Current Address, O-Registered/HQ Address, P-Business Unit Address. Alphanumeric. Length: 1. Valid Values - C/P/O. Example: O

Allowed:

preferredEmail

string

enum

required

length ≤ 1

O-Registered/HQ Address, P-Business Unit Address. Alphanumeric. Length: 1. Valid Values - P/O. Example: O

Allowed:

officeAddress

object

required

It is a JSON array of office address information.

currentAddress

object

required

It is a JSON array of current address information.

permanentAddress

object

It is a JSON array of permanent address information.

referencePersonDetails

object

It is a JSON array of reference personal details information.

paidUpCapital

string

length ≤ 19

^[0-9]*$

Numeric. Length: 19, 7. Example: ''

annualSales

string

length ≤ 19

^[0-9]*$

Numeric. Length: 19, 7. Example: ''

netSales

string

length ≤ 19

^[0-9]*$

Numeric. Length: 19, 7. Example: ''

companyDetails

object

It is a JSON array of company details information.

parentCompanyName

string

length ≤ 30

^[a-zA-Z0-9 ]*$

Alphanumeric. Length: 30. Example: ''

parentCompanyAddress

object

It is a JSON array of parent company address information.

estimatedAnnualSpendOnCards

string

length ≤ 12

^[0-9]*$

Alphanumeric. Length: 12,7. Example: ''

bankDetails

object

It is a JSON array of bank details information.

modeOfPayment

string

enum

length ≤ 1

A-Auto Debit, C-Cheque. Alphanumeric. Length: 1. Valid Values - A / C. Example: ''

Allowed:

debitBankAccountNo

string

length ≤ 20

^[a-zA-Z0-9]*$

Alphanumeric. Length: 20. Example: ''

authorisedSignatories

array of objects

It is a list of authorized signatories information.

authorisedSignatories

Headers

Correlation-ID

string

^[a-zA-Z0-9-]{1,50}$

API Consumer must share Correlation-ID in HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate a universally unique identifier (UUID) of length 32 or 36 that is compliant with RFC 4122. The maximum supported length is 50 alphanumeric characters. For example, ac97d177-9345-4934-8343-0f91a7a02836. If the Correlation-ID is not received in the incoming request, the system generates the UUID dynamically and assigns it to the request.

Source

string

API Consumer can share Source in HTTP header for API requests. For the list of Source values, see the Pre-conditions for HTTP Header of REST API topic in the Pre-requisite for Rest API section.

Response

201Successful registration.