Sign in

v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

GET Entity Account(s) [For Remitter/Student/Beneficiary]

This API allows the API user to retrieve the details for an existing Entity Account OR details of all accounts of under one Entity Type.

get/v1/client/accounts

Query parameters

userAccountIdstring

This field allows the API user to specify the Account ID for the Entity being queried [To be used WITHOUT "accountType"]

accountTypestring

This field specifies the type of Entity the GET API queries for. This can be either remitter/beneficiary/student [To be used WITHOUT "userAccountId"]

Headers

api-keystring required

API Key

auth-keystring required

Auth key generated via the "Generate Auth key API"

userIdstring required

User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.

Response

200

OR

Example response

{
  "status": 200,
  "message": "Success",
  "data": {
    "fullName": "Veronica E Mars",
    "dob": "01/11/11",
    "email": "veromars@gmail.com",
    "phone": "+918810677008",
    "country": "India",
    "state": "Karnataka",
    "city": "Bengaluru",
    "postalCode": "560068",
    "fullAddress": "Silver County Rd, Lakedew Residency- Phase 2, Sai Meadows, Parappana Agrahara, Haralur, Bengaluru, Karnataka 560068",
    "panStatus": "APPROVED",
    "createdAt": "2024-03-16T13:03:58.044Z"
  }
}