Skip to main content
GET
/
customers
/
{customerId}
cURL
curl --request GET \
  --url https://api.grainfinance.co/v1/customers/{customerId} \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api.grainfinance.co/v1/customers/{customerId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.grainfinance.co/v1/customers/{customerId}', 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://api.grainfinance.co/v1/customers/{customerId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.grainfinance.co/v1/customers/{customerId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.grainfinance.co/v1/customers/{customerId}")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.grainfinance.co/v1/customers/{customerId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "id": "1b0ada1e-fa1b-4cfe-a553-01b340c5650e",
  "companyName": "Ollivander's Wand Shop",
  "companyCountry": "GB",
  "externalCustomerId": "630231b3ae0d7e9e5097ad35",
  "companyAddress": "12 Diagon Alley",
  "companyCity": "London",
  "companyState": "London",
  "contactEmail": "customer@company.com",
  "contactFullName": "Garrick Ollivander",
  "contactPhoneNumber": "+12125551234",
  "companyTaxId": "123-45-6789",
  "extraFields": {
    "field_a": "value_a",
    "field_b": "value_b"
  }
}
{
"message": "Can't perform this action",
"reason": "Supplied object is in *Cancelled* state, which prevents performing this action"
}

Authorizations

Authorization
string
header
required

Basic authentication using the partner API keys from https://console.grainfinance.co/keys

Path Parameters

customerId
string<uuid>
required

The UUID of the customer Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Response

Customer Found

id
string<uuid>
required

The id of the customer within the Grain platform.

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}
Example:

"1b0ada1e-fa1b-4cfe-a553-01b340c5650e"

companyName
string
required

The legal name of the customer's company

Example:

"Ollivander's Wand Shop"

companyCountry
string
required

The alpha-2 ISO 3166 country code of the entity's country.

Pattern: ^[A-Za-z]{2}$
Example:

"GB"

externalCustomerId
string
required

The id used to identify the customer within your platform

Example:

"630231b3ae0d7e9e5097ad35"

status
enum<string>
required

The eligibility of the customer to receive quotes

Available options:
Pending,
Approved,
Rejected
companyAddress
string

The address of the company

Example:

"12 Diagon Alley"

companyCity
string

The city of the company

Example:

"London"

companyState
string

The state the company is in (US based)

Example:

"London"

contactEmail
string

The email for the company's primary contact

Example:

"customer@company.com"

contactFullName
string

The name of the company's primary contact

Example:

"Garrick Ollivander"

contactPhoneNumber
string

The phone number of the company's primary contact

Example:

"+12125551234"

companyTaxId
string

The tax identification or registration number of the company

Example:

"123-45-6789"

extraFields
object

Additional fields that provide further details about the customer. These fields should be specified as a valid JSON object.

Example:
{
"field_a": "value_a",
"field_b": "value_b"
}