Validator API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Validator API is used by parties interested in validating AccountChek information.

Base URLs:

Production Domain: https://validatorapi.accountchek.com

Client Testing (CTE) Domain: https://validatorapi.accountchek.net

Email: AccountChek | Web: AccountChek

Authentication

• API Key (token)
  • Parameter Name: Authorization, in: header
  • Authorization for the calls to the API is via Id and Key. The Id and Key will be assigned to you when you have been authorized to make calls to the API.

The format of the Authorization header should be "token :" without quotes.

Example Authorization Header: Authorization: token 29f16417-12b1-4015-b966-30d8c73ee656:b072975045bc4b94c0a492145308570c722272e732fbea2066b33f5170a40b07

Report

This tag is applied to operations that retrieve report data.

Get Report

Code samples

# You can also use wget
curl -X GET https://validatorapi.accountchek.com/reports/{reportId} \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET https://validatorapi.accountchek.com/reports/{reportId} HTTP/1.1
Host: validatorapi.accountchek.com
Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://validatorapi.accountchek.com/reports/{reportId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('https://validatorapi.accountchek.com/reports/{reportId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get 'https://validatorapi.accountchek.com/reports/{reportId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('https://validatorapi.accountchek.com/reports/{reportId}', headers = headers)

print(r.json())

URL obj = new URL("https://validatorapi.accountchek.com/reports/{reportId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://validatorapi.accountchek.com/reports/{reportId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://validatorapi.accountchek.com/reports/{reportId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /reports/{reportId}

Get reports for the given reportId.

Parameters

Detailed descriptions

reportId: The AccountChek VOA reportId, where reportId is a GUID (ex. 56bec533-c909-4092-8974-77af8aa3f432).

Example responses

200 Response

{
  "reports": {
    "available": "asset",
    "asset": {},
    "assetPdf": "string"
  },
  "sources": {}
}

Responses

Schemas

VOAReportData

{
  "reports": {
    "available": "asset",
    "asset": {},
    "assetPdf": "string"
  },
  "sources": {}
}

Properties

Reports

{
  "available": "asset",
  "asset": {},
  "assetPdf": "string"
}

Properties

Enumerated Values