Enkash Developer Portal
Home
Home
Login
  1. Vendor Management
  • Back to home
  • Accounts Payable APIs
  • Invoice Management
    • validateInvoices
    • initiate
    • Search Payouts V1
    • bulkCreatePayout
    • Create Payout
    • Update Payouts
    • Search Payouts
    • createBulkPayoutForPartnerIntegration
    • Update Approval Status
    • Update Bulk Payouts
    • Get Invoice Data
    • Delete Payout
    • Confirm Invoice Request
  • Vendor Management
    • Create Vendor
      POST
    • Create Bulk Vendors
      POST
    • Update Bulk Vendors
      PUT
    • Get Beneficiaries (V1)
      POST
    • Get Beneficiaries
      POST
    • Change Vendor Status
      PATCH
    • Get Beneficiary
      GET
  • Payment
    • Payment Request
    • Update Beneficiary
  1. Vendor Management

Get Beneficiaries

POST
/api/v0/beneficiary/search

Request

Body Params application/json

Example
{
    "companyIds": [
        "string"
    ],
    "parentIds": [
        0
    ],
    "offset": 0,
    "limit": 5000,
    "panOrGstin": "string",
    "companyBranchCodeIds": [
        0
    ],
    "panStatus": "UNVERIFIED",
    "gstinStatus": "UNVERIFIED",
    "cinStatus": "UNVERIFIED",
    "businessTypes": [
        "ENTERPRISE"
    ],
    "bankVerifiedStatus": "UNVERIFIED",
    "companyOnBoardType": "CUSTOMER",
    "branchCodes": [
        "string"
    ],
    "branchNames": [
        "string"
    ],
    "costCentres": [
        "string"
    ],
    "branchCities": [
        "string"
    ],
    "branchStates": [
        "string"
    ],
    "utmSource": "string",
    "userGroupIds": [
        "string"
    ],
    "isMsme": true,
    "companyIdOrLegalName": "string",
    "direction": "ASC",
    "bankApproval": "KOTAK_APPROVED",
    "bankApprovalStatus": "APPROVED",
    "kycFailureReason": "PAN_GSTIN_BANK_MISSING",
    "companyParentChildRelationIds": [
        "string"
    ],
    "company_id": "string",
    "parent_id": "string",
    "child_id": "string",
    "business_type": "ENTERPRISE",
    "company_type": "string",
    "tax_id_1": "string",
    "tax_id_2": "string",
    "cin": "string",
    "din": "string",
    "external_ref_no": "string",
    "risk_approval_status": "APPROVED",
    "status": "ACTIVE",
    "created_date_from": "2019-08-24T14:15:22Z",
    "created_date_to": "2019-08-24T14:15:22Z",
    "date_approved": "2019-08-24T14:15:22Z",
    "email": "string",
    "legal_name": "string",
    "branch_code": "string",
    "order_by": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.your-api-server.com/api/v0/beneficiary/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "companyIds": [
        "string"
    ],
    "parentIds": [
        0
    ],
    "offset": 0,
    "limit": 5000,
    "panOrGstin": "string",
    "companyBranchCodeIds": [
        0
    ],
    "panStatus": "UNVERIFIED",
    "gstinStatus": "UNVERIFIED",
    "cinStatus": "UNVERIFIED",
    "businessTypes": [
        "ENTERPRISE"
    ],
    "bankVerifiedStatus": "UNVERIFIED",
    "companyOnBoardType": "CUSTOMER",
    "branchCodes": [
        "string"
    ],
    "branchNames": [
        "string"
    ],
    "costCentres": [
        "string"
    ],
    "branchCities": [
        "string"
    ],
    "branchStates": [
        "string"
    ],
    "utmSource": "string",
    "userGroupIds": [
        "string"
    ],
    "isMsme": true,
    "companyIdOrLegalName": "string",
    "direction": "ASC",
    "bankApproval": "KOTAK_APPROVED",
    "bankApprovalStatus": "APPROVED",
    "kycFailureReason": "PAN_GSTIN_BANK_MISSING",
    "companyParentChildRelationIds": [
        "string"
    ],
    "company_id": "string",
    "parent_id": "string",
    "child_id": "string",
    "business_type": "ENTERPRISE",
    "company_type": "string",
    "tax_id_1": "string",
    "tax_id_2": "string",
    "cin": "string",
    "din": "string",
    "external_ref_no": "string",
    "risk_approval_status": "APPROVED",
    "status": "ACTIVE",
    "created_date_from": "2019-08-24T14:15:22Z",
    "created_date_to": "2019-08-24T14:15:22Z",
    "date_approved": "2019-08-24T14:15:22Z",
    "email": "string",
    "legal_name": "string",
    "branch_code": "string",
    "order_by": "string"
}'

Responses

🟢200OK
application/json
Body

Example
{}
Modified at 2025-07-07 18:41:31
Previous
Get Beneficiaries (V1)
Next
Change Vendor Status
Built with