# Register Entity ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v0/business-onboarding/reg-entity: post: summary: Register Entity deprecated: false description: >- :::highlight purple 📌 Use this API to create and register an entity in Bharat Connect System. This allows EnKash to store key details needed for compliance, verification, or future transactions. ::: tags: - Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Business Onboarding parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/RegistrationEntityRequest' examples: {} responses: '200': description: '' content: application/json: schema: type: object properties: payload: type: string response_code: type: integer response_message: type: string required: - payload - response_code - response_message x-apidog-orders: - payload - response_code - response_message x-apidog-ignore-properties: [] example: payload: SUCCESS response_code: 0 response_message: SUCCESS headers: {} x-apidog-name: Success security: [] x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Business Onboarding x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-10664774-run components: schemas: RegistrationEntityRequest: type: object properties: initiatorEntity: type: string device: type: object properties: tag: type: object properties: name: type: string enum: - GEOCODE - IP - AGENTID x-apidog-enum: - value: GEOCODE name: '' description: '' - value: IP name: '' description: '' - value: AGENTID name: '' description: '' value: type: string pattern: ^[A-Za-z0-9]^([^\\\"]){1,100}$ required: - name - value x-apidog-orders: - name - value x-apidog-ignore-properties: [] required: - tag x-apidog-orders: - tag x-apidog-ignore-properties: [] institute: type: object properties: objectId: type: string pattern: ^[ORG]{3}[A-Za-z0-9]{32,32}$ objectVersion: type: object properties: currentVersion: type: integer minimum: 1 maximum: 100 default: 1 newVersion: type: integer minimum: 1 maximum: 100 default: 1 required: - currentVersion - newVersion x-apidog-orders: - currentVersion - newVersion x-apidog-ignore-properties: [] name: type: string pattern: ^([^\\\"])*$ minLength: 1 maxLength: 256 alias: type: string defaultB2BId: type: string mccCode: type: string minLength: 4 maxLength: 4 lei: type: object properties: documentName: type: string enum: - PAN x-apidog-enum: - value: PAN name: '' description: '' type: type: string enum: - SOLE PROP - BOI - AOP - HUF - COMPANY - LLP - PARTNERSHIP FIRM - TRUST - GOVERNEMNT AGENCY - LOCAL AUTHORITY - AJP x-apidog-enum: - value: SOLE PROP name: ' ' description: '' - value: BOI name: ' ' description: '' - value: AOP name: '' description: '' - value: HUF name: ' ' description: '' - value: COMPANY name: ' ' description: '' - value: LLP name: '' description: '' - value: PARTNERSHIP FIRM name: '' description: '' - value: TRUST name: ' ' description: '' - value: GOVERNEMNT AGENCY name: ' ' description: '' - value: LOCAL AUTHORITY name: ' ' description: '' - value: AJP name: '' description: '' value: type: string pattern: '^[a-zA-Z0-9]{50}$ ' registeredName: type: string pattern: '^([^\\\"])*$ ' minLength: 1 maxLength: 256 required: - documentName - type - value - registeredName x-apidog-orders: - documentName - type - value - registeredName x-apidog-ignore-properties: [] primaryBusinessIdentifier: type: object properties: documentName: type: string enum: - GSTIN - UDYAM - SHOP ESTABLISHMENT CERTIFICATE - PAN - TAN - IEC - LEI - FACTORY LICENSE NUMBER - DRUG LICENSE NUMBER - TOURISM LICENSE NUMBER - FDA - FSSAI - HEALTH AND TRADE LICENSE NUMBER - LABOR LICENSE NUMBER - BROADCASTING AND TELECOM LICENSE NUMBER - B2BID x-apidog-enum: - value: GSTIN name: ' ' description: '' - value: UDYAM name: ' ' description: '' - value: SHOP ESTABLISHMENT CERTIFICATE name: '' description: '' - value: PAN name: ' ' description: '' - value: TAN name: ' ' description: '' - value: IEC name: ' ' description: '' - value: LEI name: ' ' description: '' - value: FACTORY LICENSE NUMBER name: ' ' description: '' - value: DRUG LICENSE NUMBER name: ' ' description: '' - value: TOURISM LICENSE NUMBER name: ' ' description: '' - value: FDA name: ' ' description: '' - value: FSSAI name: '' description: '' - value: HEALTH AND TRADE LICENSE NUMBER name: ' ' description: '' - value: LABOR LICENSE NUMBER name: ' ' description: '' - value: BROADCASTING AND TELECOM LICENSE NUMBER name: ' ' description: '' - value: B2BID name: '' description: '' value: type: string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9/_.#-]{1,100}$ registeredName: type: string required: - documentName - value - registeredName x-apidog-orders: - documentName - value - registeredName x-apidog-ignore-properties: [] otherBusinessIdentifiers: type: array items: type: object properties: documentName: type: string enum: - GSTIN - UDYAM - SHOP ESTABLISHMENT CERTIFICATE - PAN - TAN - IEC - LEI - FACTORY LICENSE NUMBER - DRUG LICENSE NUMBER - TOURISM LICENSE NUMBER - FDA - FSSAI - HEALTH AND TRADE LICENSE NUMBER - LABOR LICENSE NUMBER - BROADCASTING AND TELECOM LICENSE NUMBER - B2BID x-apidog-enum: - value: GSTIN name: ' ' description: '' - value: UDYAM name: ' ' description: '' - value: SHOP ESTABLISHMENT CERTIFICATE name: '' description: '' - value: PAN name: ' ' description: '' - value: TAN name: ' ' description: '' - value: IEC name: ' ' description: '' - value: LEI name: ' ' description: '' - value: FACTORY LICENSE NUMBER name: ' ' description: '' - value: DRUG LICENSE NUMBER name: ' ' description: '' - value: TOURISM LICENSE NUMBER name: ' ' description: '' - value: FDA name: ' ' description: '' - value: FSSAI name: '' description: '' - value: HEALTH AND TRADE LICENSE NUMBER name: ' ' description: '' - value: LABOR LICENSE NUMBER name: ' ' description: '' - value: BROADCASTING AND TELECOM LICENSE NUMBER name: ' ' description: '' - value: B2BID name: '' description: '' value: type: string pattern: ^[a-zA-Z0-9/_.#-]{1,100}$ registeredName: type: string pattern: '^([^\\\"])*$ ' minLength: 1 maxLength: 256 x-apidog-orders: - documentName - value - registeredName required: - documentName - value - registeredName x-apidog-ignore-properties: [] addresses: type: array items: type: object properties: type: type: string enum: - REGISTERED ADDRESS - CORPORATE OFFICE - BRANCH OFFICE - HEAD OFFICE - OTHER x-apidog-enum: - value: REGISTERED ADDRESS name: '' description: '' - value: CORPORATE OFFICE name: '' description: '' - value: BRANCH OFFICE name: '' description: '' - value: HEAD OFFICE name: '' description: '' - value: OTHER name: '' description: '' addressLine1: type: string pattern: '^([^\\\"])*$ ' minLength: 1 maxLength: 256 addressLine2: type: string city: type: string pattern: '^([^\\\"])*$ ' minLength: 1 maxLength: 256 state: type: string enum: - ANDAMAN AND NICOBAR ISLANDS - ANDHRA PRADESH - ARUNACHAL PRADESH - ASSAM - BIHAR - CHANDIGARH - CHHATTISGARH - DADRA AND NAGAR HAVELI AND DAMAN AND DIU - DELHI - GOA - GUJARAT - HARYANA - HIMACHAL PRADESH - JAMMU AND KASHMIR - JHARKHAND - KARNATAKA - KERALA - LADAKH - LAKSHADWEEP - MADHYA PRADESH - MAHARASHTRA - MANIPUR - MEGHALAYA - MIZORAM - NAGALAND - ODISHA - PUDUCHERRY - PUNJAB - RAJASTHAN - SIKKIM - TAMIL NADU - TELANGANA - TRIPURA - UTTAR PRADESH - UTTARAKHAND - WEST BENGAL x-apidog-enum: - value: ANDAMAN AND NICOBAR ISLANDS name: '' description: '' - value: ANDHRA PRADESH name: '' description: '' - value: ARUNACHAL PRADESH name: '' description: '' - value: ASSAM name: '' description: '' - value: BIHAR name: ' ' description: '' - value: CHANDIGARH name: '' description: '' - value: CHHATTISGARH name: ' ' description: '' - value: DADRA AND NAGAR HAVELI AND DAMAN AND DIU name: ' ' description: '' - value: DELHI name: ' ' description: '' - value: GOA name: ' ' description: '' - value: GUJARAT name: '' description: '' - value: HARYANA name: ' ' description: '' - value: HIMACHAL PRADESH name: '' description: '' - value: JAMMU AND KASHMIR name: '' description: '' - value: JHARKHAND name: ' ' description: '' - value: KARNATAKA name: '' description: '' - value: KERALA name: ' ' description: '' - value: LADAKH name: '' description: '' - value: LAKSHADWEEP name: ' ' description: '' - value: MADHYA PRADESH name: ' ' description: '' - value: MAHARASHTRA name: '' description: '' - value: MANIPUR name: ' ' description: '' - value: MEGHALAYA name: '' description: '' - value: MIZORAM name: ' ' description: '' - value: NAGALAND name: ' ' description: '' - value: ODISHA name: '' description: '' - value: PUDUCHERRY name: ' ' description: '' - value: PUNJAB name: '' description: '' - value: RAJASTHAN name: ' ' description: '' - value: SIKKIM name: ' ' description: '' - value: TAMIL NADU name: ' ' description: '' - value: TELANGANA name: ' ' description: '' - value: TRIPURA name: '' description: '' - value: UTTAR PRADESH name: '' description: '' - value: UTTARAKHAND name: ' ' description: '' - value: WEST BENGAL name: '' description: '' country: type: string enum: - INDIA x-apidog-enum: - value: INDIA name: '' description: '' pincode: type: string pattern: ^[0-9]{6}$ x-apidog-orders: - type - addressLine1 - addressLine2 - city - state - country - pincode required: - type - addressLine1 - city - state - country - pincode x-apidog-ignore-properties: [] bankAccounts: type: array items: type: object properties: businessVPA: type: string pattern: ^([^\\\"])*$ minLength: 1 maxLength: 256 type: type: string enum: - SAVINGS - CURRENT - DEFAULT - CREDIT - OVERDRAFT - LOAN - CHECKING - BANKWALLET - SOD - PPI WALLET x-apidog-enum: - value: SAVINGS name: ' ' description: '' - value: CURRENT name: '' description: '' - value: DEFAULT name: ' ' description: '' - value: CREDIT name: '' description: '' - value: OVERDRAFT name: ' ' description: '' - value: LOAN name: '' description: '' - value: CHECKING name: '' description: '' - value: BANKWALLET name: ' ' description: '' - value: SOD name: ' ' description: '' - value: PPI WALLET name: '' description: '' ifsc: type: string pattern: ^[a-zA-Z0-9]{11,11}$ acNum: type: string pattern: ^[a-zA-Z0-9]{11,30}$ beneficiaryName: type: string pattern: ^([^\\\"])*$ minLength: 1 maxLength: 256 x-apidog-orders: - businessVPA - type - ifsc - acNum - beneficiaryName required: - businessVPA - type - ifsc - acNum - beneficiaryName x-apidog-ignore-properties: [] contactNumbers: type: array items: type: object properties: type: type: string enum: - MOBILE x-apidog-enum: - value: MOBILE name: '' description: '' countryCode: type: string pattern: ^[+][0-9]{1,4}$ phoneNumber: type: string pattern: '^[0-9]{10}$ ' x-apidog-orders: - type - countryCode - phoneNumber required: - type - countryCode - phoneNumber x-apidog-ignore-properties: [] emails: type: array items: type: string pattern: '^[A-Za-z0-9+_.-]+@(.+)$ ' cin: type: string dins: type: array items: type: string primaryContactNumber: type: object properties: type: type: string enum: - MOBILE x-apidog-enum: - value: MOBILE name: '' description: '' countryCode: type: string pattern: ^[+][0-9]{1,4}$ phoneNumber: type: string pattern: ^[0-9]{10}$ required: - type - countryCode - phoneNumber x-apidog-orders: - type - countryCode - phoneNumber x-apidog-ignore-properties: [] primaryEmail: type: string pattern: ^[A-Za-z0-9+_.-]+@(.+)$ required: - objectId - objectVersion - name - defaultB2BId - mccCode - lei - primaryBusinessIdentifier - addresses - bankAccounts - contactNumbers - primaryContactNumber - primaryEmail x-apidog-orders: - objectId - objectVersion - name - alias - defaultB2BId - mccCode - lei - primaryBusinessIdentifier - otherBusinessIdentifiers - addresses - bankAccounts - contactNumbers - emails - cin - dins - primaryContactNumber - primaryEmail x-apidog-ignore-properties: [] required: - initiatorEntity - device - institute x-apidog-orders: - initiatorEntity - device - institute x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://ekpayout-uat.enkash.in description: Testing Env security: [] ```