Get Contact Requests in a Period of Time

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

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

Request

Query Parameters

from_date string
Start date to query contact 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 contact 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 [
emailstringrequired
Contact's email
first_namestringrequired
Contact's first name
last_namestringrequired
Contact's last name
typestringrequired
The type of contact (e.g., individual or organization)
Possible values: [individual, organization]
Example: individual
dobstringrequired
Contact date of birth, format 'yyyy-mm-dd'
phonestringrequired
Contact's phone number
Example: +61-412345678
reg_nostringrequired
Contact registration number.
genderstringrequired
Contact's gender
Possible values: [male, female]
Example: male
streetstringrequired
The primary 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 object
Contains the most recent KYC submission details for the contact.
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
ID document number
issue_datestringrequired
Format 'yyyy-mm-dd'
expiry_datestringrequired
Format 'yyyy-mm-dd'
kyc_statuses object[]
An array of KYC statuses for the contact, containing multiple KYC instances with status and message.
Array [
kyc_statusstring
• pending: KYC process has been initiated for the contact, but the verification is not yet completed. The contact is still in the process of submitting the necessary documents.
• failed: contact was unable to verify the KYC documents due to invalid, incomplete, or unclear information. The contact may need to resubmit the documents.
• rejected: KYC has been rejected for future transactions due to failure in meeting the required verification criteria. The contact cannot proceed with any further transactions until the issue is resolved.
• manual_review: The KYC process is under review by the compliance team to approve or reject the documents. This status typically means that the submitted documents need further examination.
• blocked: Contact's KYC has been blocked, preventing future transactions until further resolution. The block may be due to suspicious activity or a need for additional verification.
• approved: Contact has successfully passed the KYC verification, and future transactions can proceed without issue. The contact's identity has been verified and is now compliant with the platform's standards.
Possible values: [pending, failed, rejected, manual_review, blocked, approved]
messagestring
Message related to the KYC status
]
]

Example (auto)

{
  "total": 100,
  "page": 1,
  "per_page": 20,
  "records": [
    {
      "email": "test@helloclever.co",
      "first_name": "Luyx",
      "last_name": "Tran",
      "type": "individual",
      "dob": "1991-12-24",
      "phone": "+6123224242",
      "reg_no": "123456789",
      "gender": "male",
      "street": "338 George Street",
      "city": "Sydney",
      "postal_code": "2000",
      "state": "New South Wales",
      "country": "AU",
      "identity": {
        "issue_country": "AU",
        "document_number": "12345678",
        "issue_date": "2024-04-16",
        "expiry_date": "2024-04-16",
        "id_doc_type": "Passport"
      },
      "kyc_statuses": [
        {
          "kyc_status": "approved",
          "message": "null"
        },
        {
          "kyc_status": "rejected",
          "message": "KYC is rejected."
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

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

Example

{
  "errors": {
    "code": "BAD_REQUEST",
    "message": "Invalid query parameters."
  }
}

401

Unauthorized

application/json

Schema

Schema

errors object
codestring
messagestring

Example (auto)

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

Example

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

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

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v2/contacts/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

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!