Get Beneficiaries (V1)

POST

/api/v1/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 samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test.your-api-server.com/api/v1/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

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "recordsCount": 0,
        "data": [
            {
                "parentCompanyId": "string",
                "category": "A",
                "status": "ACTIVE",
                "emails": [
                    "string"
                ],
                "phone": "string",
                "kycDetailsSubmitted": true,
                "beneficiaryPan": "string",
                "beneficiaryGst": "string",
                "bankDetailApproved": true,
                "panStatus": "UNVERIFIED",
                "gstinStatus": "UNVERIFIED",
                "selfApproved": true,
                "companyParentChildRelationId": "string",
                "bankApprovalDetails": [
                    {
                        "bankApproval": "KOTAK_APPROVED",
                        "approvedOn": "2019-08-24T14:15:22Z",
                        "approvedBy": "string"
                    }
                ],
                "bankApprovalStatus": "APPROVED",
                "parent_legal_name": "string",
                "company_id": "string",
                "legal_name": "string",
                "business_type": "ENTERPRISE",
                "risk_approval_status": "APPROVED",
                "created_date": "2019-08-24T14:15:22Z",
                "tax_id_one": "string",
                "tax_id_two": "string",
                "bank_account_number": "string",
                "ifsc": "string",
                "date_modified": "2019-08-24T14:15:22Z"
            }
        ]
    }
}

Modified at 2025-07-07 18:41:31

Update Bulk Vendors

Get Beneficiaries