- Explore Our Product Suite
- Payment Gateway
- Payouts
- Prepaid Cards
- About Prepaid Card
- Key Capabilities
- Getting Started
- APIs
- API Access & Authorization
- Encryption & Decryption Guide
- Auth Token
- Create Card Account
- Create Gift Card
- Create Prepaid Card
- Set Card PIN
- Load Card Balance
- Get Card Account Details
- Generate Card OTP
- View Card Details
- Card Usage Controls
- Get Card Usage Limits
- Request Card Replacement
- Block Card
- Order Physical Card
- Get Card Details
- Get Transaction Details
- Get All Transaction details
- Bharat Connect (BBPS)
- About Bharat Connect
- Invoice Payments
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- Webhook Purchase Order
- Webhook Send Purchase Order Request
- Webhook Send Purchase Order Response
- Webhook Confirm Purchase Order Request
- Webhook Confirm Purchase Order Response
- Webhook Edit Purchase Order Request
- Webhook Edit Purchase Order Response
- Webhook Status Change Purchase Order Request
- Webhook Status Change Purchase Order Response
- Bill Payments
- Accounts Payable
- About AP Management Tool
- Vendor Management
- Invoice Management
- Bharat Connect 2.0 AP
- Update BeneficiaryPUT
- Account Receivable
- Expense Management
- Rewards & Incentives
- Verification Suite
Get Beneficiaries
POST
/api/v0/beneficiary/search
Beneficiary Apis
Request
Body Params application/json
companyIds
array[string]
optional
parentIds
array[integer <int64>]
optional
offset
integer <int32>
optional
limit
integer <int32>
optional
<= 5000
panOrGstin
string
optional
companyBranchCodeIds
array[integer <int64>]
optional
panStatus
enum<string>
optional
Allowed values:
UNVERIFIEDVERIFIEDNEFT_CALL_MADEFAILEDIMPS_CALL_MADEIN_PROCESSPARSING_FAILINVALIDAWAITING_WEBHOOK
gstinStatus
enum<string>
optional
Allowed values:
UNVERIFIEDVERIFIEDNEFT_CALL_MADEFAILEDIMPS_CALL_MADEIN_PROCESSPARSING_FAILINVALIDAWAITING_WEBHOOK
cinStatus
enum<string>
optional
Allowed values:
UNVERIFIEDVERIFIEDNEFT_CALL_MADEFAILEDIMPS_CALL_MADEIN_PROCESSPARSING_FAILINVALIDAWAITING_WEBHOOK
businessTypes
array[string]
optional
Allowed values:
ENTERPRISECREDIT_PROVIDERVENDORSOCIETYAGENCY
bankVerifiedStatus
enum<string>
optional
Allowed values:
UNVERIFIEDVERIFIEDNEFT_CALL_MADEFAILEDIMPS_CALL_MADEIN_PROCESSPARSING_FAILINVALIDAWAITING_WEBHOOK
companyOnBoardType
enum<string>
optional
Allowed values:
CUSTOMERBENEFICIARY
branchCodes
array[string]
optional
branchNames
array[string]
optional
costCentres
array[string]
optional
branchCities
array[string]
optional
branchStates
array[string]
optional
utmSource
string
optional
userGroupIds
array[string]
optional
isMsme
boolean
optional
companyIdOrLegalName
string
optional
direction
enum<string>
optional
Allowed values:
ASCDESC
bankApproval
enum<string>
optional
Allowed values:
KOTAK_APPROVEDICICI_BANK_APPROVEDENKASH_D2I_APPROVEDAMEX_D2I_APPROVEDKOTAK_REJECTEDICICI_BANK_REJECTEDENKASH_D2I_REJECTEDAMEX_D2I_REJECTED
bankApprovalStatus
enum<string>
optional
Allowed values:
APPROVEDPENDINGREJECTED
kycFailureReason
enum<string>
optional
Allowed values:
PAN_GSTIN_BANK_MISSINGPAN_GSTIN_MISSINGBANK_MISSINGPAN_GSTIN_BANK_NOT_VERIFIEDPAN_GSTIN_NOT_VERIFIEDBANK_NOT_VERIFIEDPAN_GSTIN_BANK_NOT_MATCHKYC_NOT_APPROVEDNAME_MATCHING_FAILEDAPPROVED
companyParentChildRelationIds
array[string]
optional
company_id
string
optional
parent_id
string
optional
child_id
string
optional
business_type
enum<string>
optional
Allowed values:
ENTERPRISECREDIT_PROVIDERVENDORSOCIETYAGENCY
company_type
string
optional
tax_id_1
string
optional
tax_id_2
string
optional
cin
string
optional
din
string
optional
external_ref_no
string
optional
risk_approval_status
enum<string>
optional
Allowed values:
APPROVEDPENDINGIN_PROGRESSBULK_UPLOADNEW
status
enum<string>
optional
Allowed values:
ACTIVEINACTIVEBLOCKEDLOCKED
created_date_from
string <date-time>
optional
created_date_to
string <date-time>
optional
date_approved
string <date-time>
optional
email
string
optional
legal_name
string
optional
branch_code
string
optional
order_by
string
optional
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
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
object {0}
Example
{}