Get Customer Requests in a Period of Time

GET 
https://api.cleverhub.co/api/v2/customers/

This API allows you to fetch a complete list of customer linked to your app-id. You can filter the results based on multiple query params. This API is paginated. The default is 20 transactions per page.

Request

Query Parameters

from_date string
Start date to query payment requests from, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. This datetime would be in UTC timezone
Example: 2022-01-01T00:00:00
to_date string
End date to query payment requests, format 'DD/MM/YY' or 'YYYY-MM-DDThh:mm:ss'. The datetime would be in UTC timezone
Example: 2022-01-01T00:00:00
page string

Page number to query. Currently we support 20 records per page

per_page string

Default 20 records per page

Responses

200

OK

application/json

Schema

Schema

per_pageinteger
pageinteger
total_pageinteger
records object[]
Array [
uuidstringrequired
Customer uuid
emailstringrequired
Customer's email
first_namestringrequired
Customer's first name
last_namestringrequired
Customer's last name
middle_namestring
Customer's middle name
dobstringrequired
Customer date of birth format 'yyyy-mm-dd'
phonestringrequired
Customer's phone
Example: +61-412345678
genderstringrequired
Customer's Gender
Possible values: [male, female, other]
Example: male
streetstringrequired
The primary name of an address's street.
street2string
The secondary name of an address's street.
citystringrequired
Name of an address's city or town.
postal_codestringrequired
The address's postcode
statestringrequired
The address's state / province / county.
countrystringrequired
ISO 3166-1 alpha-2 country code.
identity objectrequired
issue_countrystringrequired
ISO 3166-1 alpha-2 country code.
id_doc_typestringrequired
Type of identification document
Possible values: [passport, id_card, driving_license]
document_numberstringrequired
number ID
issue_datestringrequired
Format 'yyyy-mm-dd'
expiry_datestringrequired
Format 'yyyy-mm-dd'
]

Example (auto)

{
  "total": 100,
  "page": 1,
  "per_page": 20,
  "records": [
    {
      "uuid": "VMMAOTFQ",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string",
      "dob": "2024-04-16",
      "phone": "+61-12345523",
      "gender": "male",
      "street": "string",
      "street2": "string",
      "city": "string",
      "postal_code": "string",
      "state": "string",
      "country": "US",
      "identity": {
        "issue_country": "US",
        "document_number": "string",
        "issue_date": "2024-04-16",
        "expiry_date": "2024-04-16",
        "id_doc_type": "Passport"
      }
    }
  ]
}

400

Bad Request

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

{
  "errors": {
    "code": "string",
    "message": "string"
  }
}

Example

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

Authorization: app-id

name: app-idtype: apiKeydescription: The app-id is registered and secured inside Hello Clever system and only required when client has initiated or in the middle of the transaction.in: header

name: secret-keytype: apiKeydescription: The secret-key is our client's secret of the source. Required if a publishable key is used to retrieve the source.in: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

from_date — query

to_date — query

page — query

per_page — query

ResponseClear

Click the Send API Request button above and see the response here!