Search Accounts

Returns one or more accounts based on the search criteria.

Request

Security:

Bearer

path Parameters

version

required

string

Request Body schema: application/json

search account

program_guid required	string <uuid> Program unique Id
interest_rate_code	Array of strings or null Interest Rate Code
account_status	Array of strings or null (AccountStatus) Account status Enum: "SYSTEM" "ACTIVE" "FREEZE" "CLOSED" "OPTOUT"
limit	integer <int32> [ 1 .. 1000 ] Limit number of results to retrieve (will be defaulted to 100 if none specified)
start_index	integer or null <int32> [ 1 .. 1000 ] Index used for pagination of the result

Responses

200

Returns the list of accounts

400

Bad request

401

Unauthorized

500

Server Error

post/api/{version}/accounts/search

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"interest_rate_code": ["string"
],
"account_status": ["SYSTEM"
],
"limit": 1,
"start_index": 1
}

Response samples

application/json

{"count": 0,
"start_index": 0,
"end_index": 0,
"has_more": true,
"data": [{"person": {"identifications": [{"govt_id_type": "NOTPROVIDED",
"govt_id_number": "string"
}
],
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"birth_date": "string",
"email": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"additional_data": {"property1": "string",
"property2": "string"
},
"mobile_number": "string",
"home_number": "string",
"office_number": "string",
"base_address": {"city": "string",
"country": "str",
"address_line1": "string",
"address_line2": "string",
"postal_code": "string",
"state": "string"
},
"mailing_address": {"city": "string",
"country": "str",
"address_line1": "string",
"address_line2": "string",
"postal_code": "string",
"state": "string"
},
"billing_address": {"city": "string",
"country": "str",
"address_line1": "string",
"address_line2": "string",
"postal_code": "string",
"state": "string"
},
"nationality": "str",
"ip_address": "string",
"person_status": "INCOMPLETE",
"client_reference_id": "string",
"verfication_mode": "string",
"verfication_level": "string",
"person_forget_mode": "string",
"person_forget_mode_date": "string",
"market_notification_optin": "string",
"market_notification_optin_date": "string",
"address_lat": 0,
"address_lon": 0,
"contact_type": "string",
"profile_dd_mode": "string",
"request_code": "string",
"wallet_id": "string",
"title": "string",
"mask_govt_id_number": "string",
"comments": "string",
"jurisdiction_state": "string",
"jurisdiction_country": "str",
"beneficial_ownership": 100,
"person_relations": [{"holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
"related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
"person_relationship": "string",
"sys_utcinserted": "2019-08-24T14:15:22Z",
"sys_utcupdated": "2019-08-24T14:15:22Z"
}
],
"mask_account_number": "string",
"ledger_balance": 0,
"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f"
},
"account": {"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
"account_currency": "string",
"account_name": "string",
"account_type": "GENERAL",
"available_balance": 0,
"ledger_balance": 0,
"suspense_balance": 0,
"advance_account_details": {"account": {"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
"start_date": "2019-08-24T14:15:22Z",
"limit": 0,
"outstanding_balance": 0,
"credit_product": "string",
"cycle": "string",
"status": "string",
"payment_summary": {"outstanding_principal": 0,
"disbursement_amount": 0,
"processing_fees": 0,
"carriedbalance_fees": 0,
"total_repayment": 0,
"number_of_payments": 0
},
"payment_schedule": [{"mob": null,
"date": null,
"disbursement_principal": null,
"disbursement_fee": null,
"total": null,
"fee": null,
"principal": null,
"balance": null,
"paid_principal": null,
"paid_interest": null,
"available_balance": null,
"cycle": null,
"type": null,
"status": null
}
],
"available_date_range": [{"name": null,
"date": null
}
]
}
},
"account_status": "SYSTEM",
"last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
"post_date": "2019-08-24T14:15:22Z",
"amount": 0,
"mask_account_number": "string",
"sys_utcinserted": "2019-08-24T14:15:22Z",
"status_change_nonmon_detail": {"nonmon_guid": "3df16cd2-de7f-4e81-936e-7604855d1fd7",
"txn_date": "2019-08-24T14:15:22Z",
"channel_name": "string",
"request_code": "string",
"reason_code": "string",
"response_code": "string",
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"hash_account_number": "string",
"remarks": "string",
"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
"support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
"source_code": "string",
"source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
"reference_number": "string",
"outsort_guid": "eef602a5-424d-4eae-b4d8-4521969d8873",
"order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
"processing_start_date": "2019-08-24T14:15:22Z",
"processing_end_date": "2019-08-24T14:15:22Z",
"memo_code": "string"
}
},
"account_instrument": {"routing_number": "string",
"account_instrument_guid": "e5662964-577d-4724-b8d5-e791eee05564",
"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"account_info": {"account_type": "DDA",
"account_number": "string",
"routing_number": "string",
"rtp_routing_number": "string",
"bank_identifier": "string",
"bank_dba": "string",
"bank_address": {"city": "string",
"country": "str",
"address_line1": "string",
"address_line2": "string",
"postal_code": "string",
"state": "string"
},
"swift_code": "string",
"bank_phone": "string",
"description": "string",
"name_on_account": "string",
"accountholder_address": {"city": "string",
"country": "str",
"address_line1": "string",
"address_line2": "string",
"postal_code": "string",
"state": "string"
},
"additional_data": {"property1": "string",
"property2": "string"
}
},
"mask_account_number": "string",
"instrument_type": "BANKDDA",
"instrument_status": "ACTIVE"
},
"bo_journal": {"journal_guid": "019b8be6-224f-4e54-91ec-2a471754d334",
"base_journal_guid": "f7f0f8d8-65f8-4a63-857a-cab7f93b82f1",
"company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
"support_user_guid": "334ad5b0-1427-4c28-aac8-2d6e9614b4d0",
"journal_date": "2019-08-24T14:15:22Z",
"reason_code": "string",
"journal_entry": "string",
"source_code": "string",
"source_user_guid": "0aaedba8-146e-40a6-ad5f-54c512699647",
"status": "string",
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"source_user_name": "string",
"support_user_name": "string"
},
"person_verification_results": {"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"verification_method": "string",
"verification_date": "2019-08-24T14:15:22Z",
"govtid_number": "string",
"document_type": "string",
"document_path": "string",
"response_code": "string",
"verification_results": "string",
"reason_code": "string",
"questions": [{"prompt": "string",
"key": "string",
"options": ["string"
]
}
],
"provider_reference": "string",
"provider_name": "string",
"documents": {"document_reference": "string",
"file_type": "string",
"back_file_type": "string",
"front_docpath": "string",
"back_docpath": "string",
"face_image_docpath": "string"
}
},
"interest_rate": {"base_interest_rate": 0,
"interest_rate_code": "string",
"display_name": "string",
"interest_type": "string",
"interest_rate": 0,
"calculated_interest_rate": 0
}
}
],
"check_statuses": ["string"
]
}