Skip to main content
POST
/
customer
/
check
Check customer credentials and return an API token
curl --request POST \
  --url https://demo.onlinebillingform.com/api/v2/customer/check \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "jsmith@example.com",
  "password": "<string>"
}
'
import requests

url = "https://demo.onlinebillingform.com/api/v2/customer/check"

payload = {
"username": "jsmith@example.com",
"password": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({username: 'jsmith@example.com', password: '<string>'})
};

fetch('https://demo.onlinebillingform.com/api/v2/customer/check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://demo.onlinebillingform.com/api/v2/customer/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => 'jsmith@example.com',
'password' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://demo.onlinebillingform.com/api/v2/customer/check"

payload := strings.NewReader("{\n \"username\": \"jsmith@example.com\",\n \"password\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://demo.onlinebillingform.com/api/v2/customer/check")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"jsmith@example.com\",\n \"password\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://demo.onlinebillingform.com/api/v2/customer/check")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"jsmith@example.com\",\n \"password\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "user": {
    "id": 1,
    "name": "BillingServ Demo",
    "username": "admin",
    "email": "hello@baseserv.com",
    "account_type": 1,
    "live_api_token": "live_************************************"
  }
}
{
"success": false,
"errors": "Invalid API Key"
}
{
"success": false,
"errors": {
"id": [
"The id field is required."
]
}
}

Body

username
string<email>
required
password
string<password>
required

Response

OK

success
boolean