Create Contact

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

When processing a Payin or Payout transaction, if the require_contact parameter is true, you need to create a new contact before proceeding with the transaction. Each contact will have a unique email associated with it, ensuring that the user’s information is complete before continuing with the payment process. This email will be used during the process of calling the API to create a Payin or Payout transaction.

After successfully creating the contact, you need to perform KYC (Know Your Customer) verification for this contact if the Payin or Payout methods require KYC(require_kyc == true). This will be done through the Submit KYC API provided below. If KYC is not required, you can proceed with the transaction process without further verification. Ensure that these steps are completed thoroughly and accurately to maintain security and compliance. Wishing you success in carrying out this process!

Request

application/json

Body

emailstringrequired

Contact's email. This email will be used during the process of calling the API to create a Payin or Payout transaction. A new contact must be created to continue the payment process.

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's date of birth, format 'yyyy-mm-dd'

reg_nostringrequired

Contact registration number, required if type is organization

phonestringrequired

Contact's phone number

Example: +1234567890

genderstringrequired

Contact's gender

Possible values: [male, female]

Example: male

streetstringrequired

The primary name of an address's street for the contact.

citystringrequired

Name of an address's city or town for the contact.

postal_codestringrequired

The contact's address's postcode

statestringrequired

The contact's address's state / province / county.

countrystringrequired

ISO 3166-1 alpha-2 country code of the contact's country.

Responses

200

Created

application/json

Schema

Schema

emailstring

Example (auto)

{
  "email": "string"
}

Example

{
  "email": "test@helloclever.co"
}

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"
  }
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
messagestring

Example (auto)

{
  "errors": {
    "message": "string"
  }
}

Example

{
  "errors": {
    "message": "Email can't be blank"
  }
}

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.Post, "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 content = new StringContent("{\n  \"email\": \"test@helloclever.co\",\n  \"first_name\": \"Luxy\",\n  \"last_name\": \"Tran\",\n  \"type\": \"individual\",\n  \"dob\": \"1991-12-24\",\n  \"reg_no\": \"123456789\",\n  \"phone\": \"+6123224242\",\n  \"gender\": \"male\",\n  \"street\": \"338 George Street\",\n  \"city\": \"Sydney\",\n  \"postal_code\": \"2000\",\n  \"state\": \"New South Wales\",\n  \"country\": \"AU\"\n}", null, "application/json");
request.Content = content;
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

Body

{
  "email": "test@helloclever.co",
  "first_name": "Luxy",
  "last_name": "Tran",
  "type": "individual",
  "dob": "1991-12-24",
  "reg_no": "123456789",
  "phone": "+6123224242",
  "gender": "male",
  "street": "338 George Street",
  "city": "Sydney",
  "postal_code": "2000",
  "state": "New South Wales",
  "country": "AU"
}

ResponseClear

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