FIfinmo
Customer

Get All Customers

Changed on

Retrieve a list of all customers. You can filter the list with query parameters.

This API comes with Pagination support, you can customize limit and page query parameters as per the requirements.

get/customer

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Query parameters

typestring
Example:company

type of customer - individual or company

created_atstring
Example:2022-02-01

YYYY-MM-DD (UTC date). If you wish to search based on local time then use start_time and end_time fields

include_deletedboolean
Example:true

Include deleted customers

start_timeinteger
Example:84600

EPOCH timestamp

end_timeinteger
Example:84700

EPOCH timestamp

limitinteger
Example:10

Max number of transaction record per page. Default is 10 transactions per page

pageinteger
Example:1

The page number to return. If unspecified, the first page is returned

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": [
    {
      "company": {
        "address_city": "putney",
        "address_country": "AU",
        "address_line1": "16th",
        "address_line2": "St.",
        "address_state": "NSW",
        "address_zip_code": "560064",
        "incorporation_date": "2022-03-20T18:28:32.016Z",
        "incorporation_certificate_document_id": "org_doc_*",
        "address_proof_document_id": "org_doc_*",
        "authorized_user": {
          "address_city": "putney",
          "address_country": "AU",
          "address_line1": "16th",
          "address_line2": "St.",
          "address_state": "NSW",
          "address_zip_code": "560064",
          "country_of_residence": "AU",
          "dob": "1995-09-20",
          "email": "test@finmo.net",
          "first_name": "John",
          "identification_custom_type": null,
          "identification_type": "PASSPORT",
          "identification_value": "J82ND39DK",
          "last_name": "Doe",
          "nationality": "AU",
          "phone_country_code": "+61",
          "phone_number": "412345678",
          "phone_number_e164": "+61412345678",
          "address_proof_document_id": "org_doc_*",
          "identification_document_id": "org_doc_*"
        },
        "email": "info@finmo.net",
        "incorporation_country": "AU",
        "name": "Finmo",
        "phone_country_code": "+61",
        "phone_number": "412345678",
        "phone_number_e164": "+61412345678",
        "registration_number": "K92D00001"
      },
      "created_at": "2022-03-20T18:28:32.016Z",
      "created_by": "finmo",
      "customer_id": "customer_c24dc74e72be4e088e4aeca6bbabebd0",
      "description": "Customer 123456",
      "gca_activated_at": "2022-03-20T18:28:32.016Z",
      "gca_activation_status": "NOT_STARTED",
      "is_enabled": true,
      "account_usage_purpose": "fund movement",
      "is_active": true,
      "staus": "APPROVED",
      "is_gca_enabled": false,
      "is_wallet_ready": true,
      "is_deleted": false,
      "metadata": {
        "any-custom-ref": "INV_123"
      },
      "org_id": "org_f2476ddbf1654dac95db965d697e24d6",
      "organization_reference_id": "ref-id",
      "type": "company",
      "updated_at": "2022-03-20T18:28:32.016Z",
      "webhook_url": "finmo.net"
    }
  ]
}

Changes