# Get Beneficiaries (V1) ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/beneficiary/search: post: summary: Get Beneficiaries (V1) deprecated: false description: '' operationId: retrieveBeneficiary tags: - Accounts Payable/APIs - Accounts Payable /Vendor Management - Beneficiary Apis parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanySearchRequest' example: '' responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/ApplicationResponseGenericPaginationResponseCompanySearchResponse headers: {} x-apidog-name: OK security: [] x-apidog-folder: Accounts Payable/APIs - Accounts Payable /Vendor Management x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-18880635-run components: schemas: CompanySearchRequest: type: object properties: companyIds: type: array items: type: string parentIds: type: array items: type: integer format: int64 offset: type: integer format: int32 limit: maximum: 5000 type: integer format: int32 panOrGstin: type: string companyBranchCodeIds: type: array items: type: integer format: int64 panStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK gstinStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK cinStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK businessTypes: type: array items: type: string enum: - ENTERPRISE - CREDIT_PROVIDER - VENDOR - SOCIETY - AGENCY bankVerifiedStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK companyOnBoardType: type: string enum: - CUSTOMER - BENEFICIARY branchCodes: type: array items: type: string branchNames: type: array items: type: string costCentres: type: array items: type: string branchCities: type: array items: type: string branchStates: type: array items: type: string utmSource: type: string userGroupIds: type: array items: type: string isMsme: type: boolean companyIdOrLegalName: type: string direction: type: string enum: - ASC - DESC bankApproval: type: string enum: - KOTAK_APPROVED - ICICI_BANK_APPROVED - ENKASH_D2I_APPROVED - AMEX_D2I_APPROVED - KOTAK_REJECTED - ICICI_BANK_REJECTED - ENKASH_D2I_REJECTED - AMEX_D2I_REJECTED bankApprovalStatus: type: string enum: - APPROVED - PENDING - REJECTED kycFailureReason: type: string enum: - PAN_GSTIN_BANK_MISSING - PAN_GSTIN_MISSING - BANK_MISSING - PAN_GSTIN_BANK_NOT_VERIFIED - PAN_GSTIN_NOT_VERIFIED - BANK_NOT_VERIFIED - PAN_GSTIN_BANK_NOT_MATCH - KYC_NOT_APPROVED - NAME_MATCHING_FAILED - APPROVED companyParentChildRelationIds: type: array items: type: string company_id: type: string parent_id: type: string child_id: type: string business_type: type: string enum: - ENTERPRISE - CREDIT_PROVIDER - VENDOR - SOCIETY - AGENCY company_type: type: string tax_id_1: type: string tax_id_2: type: string cin: type: string din: type: string external_ref_no: type: string risk_approval_status: type: string enum: - APPROVED - PENDING - IN_PROGRESS - BULK_UPLOAD - NEW status: type: string enum: - ACTIVE - INACTIVE - BLOCKED - LOCKED created_date_from: type: string format: date-time created_date_to: type: string format: date-time date_approved: type: string format: date-time email: type: string legal_name: type: string branch_code: type: string order_by: type: string x-apidog-orders: - companyIds - parentIds - offset - limit - panOrGstin - companyBranchCodeIds - panStatus - gstinStatus - cinStatus - businessTypes - bankVerifiedStatus - companyOnBoardType - branchCodes - branchNames - costCentres - branchCities - branchStates - utmSource - userGroupIds - isMsme - companyIdOrLegalName - direction - bankApproval - bankApprovalStatus - kycFailureReason - companyParentChildRelationIds - company_id - parent_id - child_id - business_type - company_type - tax_id_1 - tax_id_2 - cin - din - external_ref_no - risk_approval_status - status - created_date_from - created_date_to - date_approved - email - legal_name - branch_code - order_by x-apidog-ignore-properties: [] x-apidog-folder: '' ApplicationResponseGenericPaginationResponseCompanySearchResponse: type: object properties: response_code: type: integer format: int32 response_message: type: string payload: $ref: '#/components/schemas/GenericPaginationResponseCompanySearchResponse' x-apidog-orders: - response_code - response_message - payload x-apidog-ignore-properties: [] x-apidog-folder: '' GenericPaginationResponseCompanySearchResponse: type: object properties: recordsCount: type: integer format: int64 data: type: array items: $ref: '#/components/schemas/CompanySearchResponse' x-apidog-orders: - recordsCount - data x-apidog-ignore-properties: [] x-apidog-folder: '' CompanySearchResponse: type: object properties: parentCompanyId: type: string category: type: string enum: - A - B - C - D - TA - UTILITY - FUEL - IATA - OTHERS - RENTAL - KASHFLO - QUICK_RENT_PAY status: type: string enum: - ACTIVE - INACTIVE - BLOCKED - LOCKED emails: type: array items: type: string phone: type: string kycDetailsSubmitted: type: boolean beneficiaryPan: type: string beneficiaryGst: type: string bankDetailApproved: type: boolean panStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK gstinStatus: type: string enum: - UNVERIFIED - VERIFIED - NEFT_CALL_MADE - FAILED - IMPS_CALL_MADE - IN_PROCESS - PARSING_FAIL - INVALID - AWAITING_WEBHOOK selfApproved: type: boolean companyParentChildRelationId: type: string bankApprovalDetails: type: array items: $ref: '#/components/schemas/BankApprovalDetail' bankApprovalStatus: type: string enum: - APPROVED - PENDING - REJECTED parent_legal_name: type: string company_id: type: string legal_name: type: string business_type: type: string enum: - ENTERPRISE - CREDIT_PROVIDER - VENDOR - SOCIETY - AGENCY risk_approval_status: type: string enum: - APPROVED - PENDING - IN_PROGRESS - BULK_UPLOAD - NEW created_date: type: string format: date-time tax_id_one: type: string tax_id_two: type: string bank_account_number: type: string ifsc: type: string date_modified: type: string format: date-time x-apidog-orders: - parentCompanyId - category - status - emails - phone - kycDetailsSubmitted - beneficiaryPan - beneficiaryGst - bankDetailApproved - panStatus - gstinStatus - selfApproved - companyParentChildRelationId - bankApprovalDetails - bankApprovalStatus - parent_legal_name - company_id - legal_name - business_type - risk_approval_status - created_date - tax_id_one - tax_id_two - bank_account_number - ifsc - date_modified x-apidog-ignore-properties: [] x-apidog-folder: '' BankApprovalDetail: type: object properties: bankApproval: type: string enum: - KOTAK_APPROVED - ICICI_BANK_APPROVED - ENKASH_D2I_APPROVED - AMEX_D2I_APPROVED - KOTAK_REJECTED - ICICI_BANK_REJECTED - ENKASH_D2I_REJECTED - AMEX_D2I_REJECTED approvedOn: type: string format: date-time approvedBy: type: string x-apidog-orders: - bankApproval - approvedOn - approvedBy x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://ekpayout-uat.enkash.in description: Testing Env security: [] ```