m2pfintech
API LibraryBranch Address Management

Search addresses by field and value

Partial-match search within address records of a specific entity. Provide the address field name to search on and a value for case-insensitive partial matching. All three fields (entityId, field, value) are required.

POST
/business/address/search

Query Parameters

pageNumber?integer

Zero-based page index

Default0
Formatint32
pageSize?integer

Number of records per page

Default10
Formatint32

Header Parameters

TENANT*string

Tenant identifier. Required for every request.

Request Body

application/json

entityId?string

Unique identifier of the Corporate or Program entity whose addresses are being searched.

Length1 <= length
field?string

Address field name to perform the partial-match search on (e.g., city, pinCode).

Length1 <= length
value?string

Search value to match (case-insensitive partial match) against the specified field.

Length1 <= length

Response Body

application/json

application/json

application/json

curl -X POST "https://api.m2pfintech.com/credit-customer/business/address/search" \  -H "TENANT: string" \  -H "Content-Type: application/json" \  -d '{    "entityId": "CORP001",    "field": "city",    "value": "Mumbai"  }'
{
  "result": [
    {
      "addressList": [
        {
          "addressType": "BRANCH_ADDRESS",
          "branchId": "BR001",
          "city": "Mumbai",
          "state": "Maharashtra",
          "country": "INDIA",
          "status": "ACTIVE"
        }
      ]
    }
  ],
  "exception": null,
  "pagination": {
    "pageNumber": 0,
    "pageSize": 10,
    "totalElements": 1,
    "totalPages": 1
  }
}
{
  "result": null,
  "exception": {
    "errorCode": "ERR_400",
    "shortMessage": "Bad Request",
    "detailMessage": "Validation error — check field values and enum constraints."
  },
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "ERR_500",
    "shortMessage": "Internal Server Error",
    "detailMessage": "An unexpected error occurred. Please try again later."
  },
  "pagination": null
}

Fetch addresses of a Corporate/Program entity POST

Returns a paginated list of addresses for the given `entityId`. Optionally filter by `addressType` or `branchId` to narrow results. An empty `addressList` in the response means no addresses matched the filter.

Request physical card POST

Submits a request to issue a physical card for the specified entity.