Create Customer

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

Request

application/json

Body

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 / country. When country is US, CA, or AU, this field is required and must be a valid state/province code for that country (e.g., CA for California, NSW for New South Wales, ON for Ontario).

countrystringrequired

ISO 3166-1 alpha-2 country code.

typestring

Customer type. Allowed values: individual, organization. If provided, must be one of the valid types.

Possible values: [individual, organization]

Example: organization

reg_nostring

Registration number. Required when type is organization.

Example: 10242424

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'

Responses

200

Created

application/json

Schema

Schema

uuidstring
emailstring

Example (auto)

{
  "uuid": "string",
  "email": "string"
}

Example

{
  "uuid": "customer_clever12234",
  "email": "JohnDoe@mail.com"
}

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
amountstring

Example (auto)

{
  "errors": {
    "amount": "string"
  }
}

Example

{
  "errors": {
    "amount": "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/customers");
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\": \"string\",\n  \"first_name\": \"string\",\n  \"last_name\": \"string\",\n  \"middle_name\": \"string\",\n  \"dob\": \"2024-04-16\",\n  \"gender\": \"male\",\n  \"phone\": \"+61-1234523\",\n  \"street\": \"string\",\n  \"street2\": \"string\",\n  \"city\": \"string\",\n  \"postal_code\": \"string\",\n  \"state\": \"CA\",\n  \"country\": \"US\",\n  \"type\": \"organization\",\n  \"reg_no\": \"10242424\",\n  \"identity\": {\n    \"issue_country\": \"US\",\n    \"document_number\": \"string\",\n    \"issue_date\": \"2024-04-16\",\n    \"expiry_date\": \"2024-04-16\",\n    \"id_doc_type\": \"Passport\"\n  }\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": "string",
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string",
  "dob": "2024-04-16",
  "gender": "male",
  "phone": "+61-1234523",
  "street": "string",
  "street2": "string",
  "city": "string",
  "postal_code": "string",
  "state": "CA",
  "country": "US",
  "type": "organization",
  "reg_no": "10242424",
  "identity": {
    "issue_country": "US",
    "document_number": "string",
    "issue_date": "2024-04-16",
    "expiry_date": "2024-04-16",
    "id_doc_type": "Passport"
  }
}

ResponseClear

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