NAV Navigation
Shell HTTP JavaScript Node.JS Ruby Python Java Go

Business Verifications v0.1.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.

This API manages the set of operations that allow financial institutions to verify business identities as well as the identities of authorized representatives connected to the business. Vetting business identites can help financial institutions standardize and build consistency in decisioning processes. This vetting consists of verifying the business as well as the authorized signers associated with the business.

Buisness Identification consists of the following attributes:

Authorized Signer Identification consists of the following attributes:

A verification report accepts an array of authorized signers to allow for verifying multiple identities associated with a business.

Submitting a request to generate a verification report

A verification report can be generated by passing the above data points in a POST /verificationReports. The response will contain an input object which will echo the data that was sent on the POST request. It will also contain an output object which will hold the unique transactionId and state for the report as well as any risk factors, risk factor codes and risk factor descriptions flagged by the report.

It is possible to link an organization resource to a verification report by passing an apiture:organization URI in the _links object when calling a POST /verificationReports. If the optional apiture:organization link is supplied to the POST /businessVerifications call, you can retrieve that organizations verification status by calling GET /businessVerifications?organizationUri={organizationUri}. If apiture:organization is not included in this POST, results can be retrieved by calling GET /verificationReports/{verificationReportId}

Checking the verification status for an organization

If the optional apiture:organization link was passed on the POST /verificationReports, it is possible to view the verification status of that organization by calling GET /businessVerifications?organizationUri=/organization/organization/{organizationId}. The response from GET /businessVerifications will contain an embedded list of of businessVerifications, each of which will contain a type.

The two possible values are verificationReport or administratorApproval. A verificationReport will point back to a verification report resource. An administratorApproval will point back to an Approval resource. The presence of an administratorApproval record signifies that a member of the financial institution has made a decision regarding the verification status of an organization. This decision acts as an override to any previous verification report results. If a verification report is run and successfully verifies the identity of the business, an approval record will be automatically generated with a state: 'passed'.

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

Authentication

Scope Scope Description
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to perssonally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the profiles/read scope in order to read such data, but is included in the profiles/full scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/full Full access to system configuration.

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET /businessVerifications/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET /businessVerifications/ HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: '/businessVerifications/',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('/businessVerifications/',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get '/businessVerifications/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('/businessVerifications/', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET /

Return links to the top-level resources and operations in this API.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/root/v1.0.0/profile.json",
  "_links": {}
}

Responses

StatusDescription
200 OK
OK
Schema: root

getApiDoc

Code samples

# You can also use wget
curl -X GET /businessVerifications/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET /businessVerifications/apiDoc HTTP/1.1

Accept: application/json

var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: '/businessVerifications/apiDoc',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('/businessVerifications/apiDoc',
{
  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',
  'API-Key' => 'API_KEY'
}

result = RestClient.get '/businessVerifications/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'API-Key': 'API_KEY'
}

r = requests.get('/businessVerifications/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/apiDoc");
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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK
Schema: Inline

Response Schema

Verification Report

Business VerificationReport

getVerificationReports

Code samples

# You can also use wget
curl -X GET /businessVerifications/verificationReports \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/verificationReports HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/verificationReports',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/verificationReports',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/verificationReports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/verificationReports', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/verificationReports");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/verificationReports", data)
    req.Header = headers

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

Return a collection of verification reports

GET /verificationReports

Return a paginated sortable filterable searchable collection of verification reports which have been run in the past. The links in the response include pagination links.

Parameters

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first verification report item to include in this page. The default 0 denotes the beginning of the collection.
limit
(query)
integer(int32)
The maximum number of verification report representations to return in this page.
sortBy
(query)
string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter
(query)
string
Optional filter criteria. See filtering.
q
(query)
string
Optional search string. See searching.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

start

limit

sortBy

filter

q

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/verificationReports/v0.1.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "verificationReports",
  "_links": {
    "self": {
      "href": "/businessVerifications/verificationReports?start=10&limit=10"
    },
    "first": {
      "href": "/businessVerifications/verificationReports?start=0&limit=10"
    },
    "next": {
      "href": "/businessVerifications/verificationReports?start=20&limit=10"
    },
    "collection": {
      "href": "/businessVerifications/verificationReports"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "http://api.apiture.com/schemas/businessVerifications/verificationReports/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:organization": {
            "href": "/organizations/organizations/6734fdsa-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "reportScoringSummary": {
          "transactionId": "578490325jk439834yuf43",
          "state": "failed",
          "businessVerification": [
            {
              "value": 40,
              "description": "Strong verification of the input data is confirmed"
            }
          ],
          "businessRiskFactors": [
            {
              "riskCode": "20",
              "description": "Unable to verify business address on business records"
            },
            {
              "riskCode": "21",
              "description": "Unable to verify business TIN on business records"
            }
          ],
          "comprehensiveVerificationScores": [
            {
              "inputRepNumber": "1",
              "score": 20,
              "description": "Full name, address, phone, SSN verified"
            }
          ],
          "authorizedRepresentativeRiskFactors": [
            {
              "riskCode": "81",
              "description": "The input date-of-birth was missing or incomplete"
            },
            {
              "riskCode": "25",
              "description": "Unable to verify address"
            }
          ]
        }
      }
    ]
  }
}

Responses

StatusDescription
200 OK
OK
Schema: verificationReports
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

createVerificationReport

Code samples

# You can also use wget
curl -X POST /businessVerifications/verificationReports \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /businessVerifications/verificationReports HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/verificationReports',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/verificationReports/v1.0.0/profile.json"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/verificationReports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/businessVerifications/verificationReports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/businessVerifications/verificationReports', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/verificationReports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/businessVerifications/verificationReports", data)
    req.Header = headers

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

Create a new verification report

POST /verificationReports

Create a new verification report in the verification reports collection. If the optional apiture:organization link is supplied in this request, the verification report will be linked to the Organization. In addition you will be able to retrieve that organizations verification status by calling GET /businessVerifications?organizationUri={organizationUri}. If the apiture:organization link is not included in this POST reuest, the verification report and results can only be retrieved by calling GET /verificationReports/{verificationReportId}. If the supplied apiture:organization URI is invalid, a 400 Bad Request will be returned. The following _links will be included in a succesful response

Body parameter

{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/verificationReports/v1.0.0/profile.json"
}

Parameters

Parameter Description
body
(body)
createVerificationReport (required)
The data necessary to create a new verification report.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodPOST
* URL
* API Key
* Access Token

* body

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "createdAt": "2018-04-17T10:04:46.375Z",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "input": {
    "businessName": "ABC EXAMPLE CO.",
    "phone": "555-555-1234",
    "identification": [
      {
        "type": "taxId",
        "value": "12-347894309"
      }
    ],
    "authorizedSigners": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "identification": [
          {
            "type": "taxId",
            "value": "121-34-5431"
          }
        ],
        "birthdate": "1980-12-01",
        "email": "email@email.com"
      }
    ],
    "addresses": [
      {
        "addressLine1": "3212 N. 2nd Ave.",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28412"
      }
    ]
  },
  "reportScoringSummary": {
    "transactionId": "578490325jk439834yuf43",
    "state": "failed",
    "businessVerification": [
      {
        "value": 40,
        "description": "Strong verification of the input data is confirmed"
      }
    ],
    "businessRiskFactors": [
      {
        "riskCode": "20",
        "description": "Unable to verify business address on business records"
      },
      {
        "riskCode": "21",
        "description": "Unable to verify business TIN on business records"
      }
    ],
    "comprehensiveVerificationScores": [
      {
        "inputRepNumber": "1",
        "score": 20,
        "description": "Full name, address, phone, SSN verified"
      }
    ],
    "authorizedRepresentativeRiskFactors": [
      {
        "riskCode": "81",
        "description": "The input date-of-birth was missing or incomplete"
      },
      {
        "riskCode": "25",
        "description": "Unable to verify address"
      }
    ]
  },
  "reportResults": {}
}

Responses

StatusDescription
201 Created
Created
Schema: verificationReport
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
201 Location string uri
The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme://host
201 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource.

getVerificationReport

Code samples

# You can also use wget
curl -X GET /businessVerifications/verificationReports/{verificationReportId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/verificationReports/{verificationReportId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/verificationReports/{verificationReportId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/verificationReports/{verificationReportId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/verificationReports/{verificationReportId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/verificationReports/{verificationReportId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/verificationReports/{verificationReportId}");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/verificationReports/{verificationReportId}", data)
    req.Header = headers

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

Fetch a representation of this verification report

GET /verificationReports/{verificationReportId}

Return a HAL representation of this verification report resource. The following links will be included in a successful response under the _links property:

Parameters

Parameter Description
verificationReportId
(path)
string (required)
The unique identifier of this verification report. This is an opaque string.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

* verificationReportId

If-None-Match

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "createdAt": "2018-04-17T10:04:46.375Z",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "input": {
    "businessName": "ABC EXAMPLE CO.",
    "phone": "555-555-1234",
    "identification": [
      {
        "type": "taxId",
        "value": "12-347894309"
      }
    ],
    "authorizedSigners": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "identification": [
          {
            "type": "taxId",
            "value": "121-34-5431"
          }
        ],
        "birthdate": "1980-12-01",
        "email": "email@email.com"
      }
    ],
    "addresses": [
      {
        "addressLine1": "3212 N. 2nd Ave.",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28412"
      }
    ]
  },
  "reportScoringSummary": {
    "transactionId": "578490325jk439834yuf43",
    "state": "failed",
    "businessVerification": [
      {
        "value": 40,
        "description": "Strong verification of the input data is confirmed"
      }
    ],
    "businessRiskFactors": [
      {
        "riskCode": "20",
        "description": "Unable to verify business address on business records"
      },
      {
        "riskCode": "21",
        "description": "Unable to verify business TIN on business records"
      }
    ],
    "comprehensiveVerificationScores": [
      {
        "inputRepNumber": "1",
        "score": 20,
        "description": "Full name, address, phone, SSN verified"
      }
    ],
    "authorizedRepresentativeRiskFactors": [
      {
        "riskCode": "81",
        "description": "The input date-of-birth was missing or incomplete"
      },
      {
        "riskCode": "25",
        "description": "Unable to verify address"
      }
    ]
  },
  "reportResults": {}
}

Responses

StatusDescription
200 OK
OK
Schema: verificationReport
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such verification report resource at the specified {verificationReportId}. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this verification report resource.

Verification Status

Check verification status of a business

getBusinessVerifications

Code samples

# You can also use wget
curl -X GET /businessVerifications/businessVerifications?organizationUri=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/businessVerifications?organizationUri=string HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/businessVerifications',
  method: 'get',
  data: '?organizationUri=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/businessVerifications?organizationUri=string',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/businessVerifications',
  params: {
  'organizationUri' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/businessVerifications', params={
  'organizationUri': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/businessVerifications?organizationUri=string");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/businessVerifications", data)
    req.Header = headers

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

Retrieves business verification resources.

GET /businessVerifications

Retrieves the business verification status. This operation requires an organizationUri matching theapiture:organization link that was supplied on the POST /verificationReports. If the organizationUri link is invalid a 400 Bad Request response will be returned. The following links will be included in a successful response under the _links property:

The response will contain an embedded list of of businessVerifications, each of which will contain a type. The two possible values are:

A verificationReport will point back to a verificationReport resource. An administratorApproval will point back to an apiture:approval resource. The presence of an administratorApproval record signifies that a member of the financial institution has made a decision regarding the verification status of an Organization. This decision acts as an override to any previous verification report results.

Parameters

Parameter Description
organizationUri
(query)
string (required)
The apiture:organization URI.
type
(query)
string
The identity method type. Possible values are verificationReport or administratorApproval.

Enumerated Values

Parameter Value
type verificationReport
type administratorApproval

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

* organizationUri

type

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    },
    "apiture:organization": {
      "href": "/organizations/organizations/6734fdsa-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "businessVerifications": [
    {
      "state": "failed",
      "completedAt": "2018-04-17T10:04:46.375Z",
      "type": "verificationReport",
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_links": {
        "apiture:verificationReport": {
          "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    {
      "state": "passed",
      "completedAt": "2018-04-17T10:04:46.375Z",
      "type": "administratorApproval",
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_links": {
        "apiture:approval": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK
Schema: businessVerifications
400 Bad Request
Bad Request. The Organization URI was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse

Configuration

A set of endpoints that allows for the creation and retrieval of configuration options specific to this service

getConfiguration

Code samples

# You can also use wget
curl -X GET /businessVerifications/configuration \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/configuration HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/configuration',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/configuration',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/configuration',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/configuration', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/configuration");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/configuration", data)
    req.Header = headers

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

Configuration definition for this API

GET /configuration

Returns the configuration for this API

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "/businessVerifications/configuration/"
    },
    "apiture:groups": {
      "href": "/businessVerifications/configuration/groups"
    }
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configuration

getConfigGroups

Code samples

# You can also use wget
curl -X GET /businessVerifications/configuration/groups \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/configuration/groups HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/configuration/groups',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/configuration/groups',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/configuration/groups',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/configuration/groups', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/configuration/groups");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/configuration/groups", data)
    req.Header = headers

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

Return a collection of configuration groups

GET /configuration/groups

Return a paginated sortable filterable searchable collection of configuration groups. The links in the response include pagination links.

Parameters

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
limit
(query)
integer(int32)
The maximum number of configuration group representations to return in this page.
sortBy
(query)
string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter
(query)
string
Optional filter criteria. See filtering.
q
(query)
string
Optional search string. See searching.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

start

limit

sortBy

filter

q

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/configurationGroups/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_links": {
    "self": {
      "href": "/businessVerifications/configuration/groups?start=10&limit=10"
    },
    "first": {
      "href": "/businessVerifications/configuration/groups?start=0&limit=10"
    },
    "next": {
      "href": "/businessVerifications/configuration/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/businessVerifications/configuration/groups"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "http://api.apiture.com/schemas/businessVerifications/configurationGroup/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configuration/groups/rules"
          },
          "apiture:configuration": {
            "href": "/configuration"
          }
        },
        "name": "rules",
        "label": "Verification Rules",
        "description": "The basic pass-fail verification rules for the Business Verifications API"
      }
    ]
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configurationGroups
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getConfigGroup

Code samples

# You can also use wget
curl -X GET /businessVerifications/configuration/groups/{groupName} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/configuration/groups/{groupName} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/configuration/groups/{groupName}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/configuration/groups/{groupName}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/configuration/groups/{groupName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/configuration/groups/{groupName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/configuration/groups/{groupName}");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/configuration/groups/{groupName}", data)
    req.Header = headers

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

Fetch a representation of this configuration group

GET /configuration/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

* groupName

If-None-Match

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/configurationGroup/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/configuration/groups/rules"
    },
    "apiture:configuration": {
      "href": "/configuration"
    }
  },
  "name": "rules",
  "label": "Verification Rules",
  "description": "The basic pass-fail verification rules for the Business Verifications API",
  "schema": {
    "type": "object",
    "properties": {
      "minBusinessVerificationScore": {
        "type": "string",
        "description": "The minimum pass score for Business Verification"
      },
      "minAuthRepVerificationScore": {
        "type": "string",
        "description": "The minimum pass score for Authorized Rep Verification"
      },
      "minCombinedVerificationScore": {
        "type": "string",
        "description": "The minimum combined Business and Rep Verification Score"
      },
      "autoFailBizRiskFactors": {
        "type": "string",
        "description": "Array of auto fail business risk factors"
      },
      "autoFailEntityRiskFactors": {
        "type": "string",
        "description": "Array of auto fail entity risk factors"
      }
    }
  },
  "values": {
    "minBusinessVerificationScore": "30",
    "minAuthRepVerificationScore": "30",
    "minCombinedVerificationScore": "70",
    "autoFailBizRiskFactors": "",
    "autoFailEntityRiskFactors": ""
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configurationGroup
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: error

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which may be provided in an If-None-Match request header for GET operations for this configuration group resource.

getConfigGroupSchema

Code samples

# You can also use wget
curl -X GET /businessVerifications/configuration/groups/{groupName}/schema \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/configuration/groups/{groupName}/schema HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/configuration/groups/{groupName}/schema',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/configuration/groups/{groupName}/schema',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/configuration/groups/{groupName}/schema',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/configuration/groups/{groupName}/schema', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/configuration/groups/{groupName}/schema");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/configuration/groups/{groupName}/schema", data)
    req.Header = headers

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

Fetch the schema for this configuration group

GET /configuration/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

* groupName

If-None-Match

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "minBusinessVerificationScore": {
      "type": "string",
      "description": "The minimum pass score for Business Verification"
    },
    "minAuthRepVerificationScore": {
      "type": "string",
      "description": "The minimum pass score for Authorized Rep Verification"
    },
    "minCombinedVerificationScore": {
      "type": "string",
      "description": "The minimum combined Business and Rep Verification Score"
    },
    "autoFailBizRiskFactors": {
      "type": "string",
      "description": "Array of auto fail business risk factors"
    },
    "autoFailEntityRiskFactors": {
      "type": "string",
      "description": "Array of auto fail entity risk factors"
    }
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configurationSchema
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: error

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

getConfigGroupValues

Code samples

# You can also use wget
curl -X GET /businessVerifications/configuration/groups/{groupName}/values \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/configuration/groups/{groupName}/values HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/configuration/groups/{groupName}/values',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/configuration/groups/{groupName}/values',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/configuration/groups/{groupName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/configuration/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/configuration/groups/{groupName}/values");
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/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/configuration/groups/{groupName}/values", data)
    req.Header = headers

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

Fetch the values for the specified configuration group

GET /configuration/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

* groupName

If-None-Match

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "minBusinessVerificationScore": "30",
  "minAuthRepVerificationScore": "30",
  "minCombinedVerificationScore": "70",
  "autoFailBizRiskFactors": "",
  "autoFailEntityRiskFactors": ""
}

Responses

StatusDescription
200 OK
OK
Schema: configurationValues
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
404 Not Found
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: error

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

updateConfigGroupValues

Code samples

# You can also use wget
curl -X PUT /businessVerifications/configuration/groups/{groupName}/values \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT /businessVerifications/configuration/groups/{groupName}/values HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/configuration/groups/{groupName}/values',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "minBusinessVerificationScore": "30",
  "minAuthRepVerificationScore": "30",
  "minCombinedVerificationScore": "70",
  "autoFailBizRiskFactors": "",
  "autoFailEntityRiskFactors": ""
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/configuration/groups/{groupName}/values',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/businessVerifications/configuration/groups/{groupName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/businessVerifications/configuration/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/configuration/groups/{groupName}/values");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/businessVerifications/configuration/groups/{groupName}/values", data)
    req.Header = headers

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

Update the values for the specified configuration group

PUT /configuration/groups/{groupName}/values

Perform a complete replacement of this set of values

Body parameter

{
  "minBusinessVerificationScore": "30",
  "minAuthRepVerificationScore": "30",
  "minCombinedVerificationScore": "70",
  "autoFailBizRiskFactors": "",
  "autoFailEntityRiskFactors": ""
}

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
If-Match
(header)
string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)
configurationValues (required)

Try it

Fields marked with * are mandatory.

ParameterValue
MethodPUT
* URL
* API Key
* Access Token

* groupName

* If-Match

* body

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "minBusinessVerificationScore": {
      "type": "string",
      "description": "The minimum pass score for Business Verification"
    },
    "minAuthRepVerificationScore": {
      "type": "string",
      "description": "The minimum pass score for Authorized Rep Verification"
    },
    "minCombinedVerificationScore": {
      "type": "string",
      "description": "The minimum combined Business and Rep Verification Score"
    },
    "autoFailBizRiskFactors": {
      "type": "string",
      "description": "Array of auto fail business risk factors"
    },
    "autoFailEntityRiskFactors": {
      "type": "string",
      "description": "Array of auto fail entity risk factors"
    }
  }
}

Responses

StatusDescription
200 OK
OK
Schema: configurationSchema
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
404 Not Found
Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: error
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
428 Precondition Required
Precondition Required. The request did not include the required if-Match header. Resubmit with the operation, supplying the value of the ETag and the most recent state of the resource.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

getConfigGroupValue

Code samples

# You can also use wget
curl -X GET /businessVerifications/configuration/groups/{groupName}/values/{valueName} \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /businessVerifications/configuration/groups/{groupName}/values/{valueName} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/configuration/groups/{groupName}/values/{valueName}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/configuration/groups/{groupName}/values/{valueName}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/businessVerifications/configuration/groups/{groupName}/values/{valueName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/businessVerifications/configuration/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/configuration/groups/{groupName}/values/{valueName}");
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/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/businessVerifications/configuration/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Fetch a single value associated with the specified configuration group

GET /configuration/groups/{groupName}/values/{valueName}

Fetch a single value associated with this configuration group. This provides convenient access to the map of values of the configuration group. To update a specific value, use PUT /businessVerifications/configuration/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
valueName
(path)
string (required)
The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*

Try it

Fields marked with * are mandatory.

ParameterValue
MethodGET
* URL
* API Key
* Access Token

* groupName

* valueName

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK
Schema: Inline
404 Not Found
Not Found. There is either no such configuration group resource at the specified {groupName} or no such value at the specified {valueName}. The _error field in the response will contain details about the request error.
Schema: error

Response Schema

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this configuration group resource.

updateConfigGroupValue

Code samples

# You can also use wget
curl -X PUT /businessVerifications/configuration/groups/{groupName}/values/{valueName} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT /businessVerifications/configuration/groups/{groupName}/values/{valueName} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/businessVerifications/configuration/groups/{groupName}/values/{valueName}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/businessVerifications/configuration/groups/{groupName}/values/{valueName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/businessVerifications/configuration/groups/{groupName}/values/{valueName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/businessVerifications/configuration/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/businessVerifications/configuration/groups/{groupName}/values/{valueName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/businessVerifications/configuration/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Update a single value associated with the specified configuration group

PUT /configuration/groups/{groupName}/values/{valueName}

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's schema. The request body must conform to the configuration group's schema for the named {valueName}. This operation is idempotent. To update a specific value, use PUT /businessVErifications/configuration/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Body parameter

{}

Parameters

Parameter Description
groupName
(path)
string (required)
The unique name of this configuration group.
valueName
(path)
string (required)
The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*
body
(body)
attributes (required)

Try it

Fields marked with * are mandatory.

ParameterValue
MethodPUT
* URL
* API Key
* Access Token

* groupName

* valueName

* body

Response

Response Code:

Response Headers:

Response Body:

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK
Schema: Inline

Response Schema

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this configuration group resource.

Schemas

verificationRequestFields

{
  "businessName": "ABC EXAMPLE CO.",
  "phone": "555-555-1234",
  "identification": [
    {
      "type": "taxId",
      "value": "12-347894309"
    }
  ],
  "attributes": {},
  "addresses": [
    {
      "addressLine1": "3212 N. 2nd Ave.",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28412"
    }
  ],
  "authorizedSigners": [
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "identification": [
        {
          "type": "taxId",
          "value": "121-34-5431"
        }
      ],
      "birthdate": "1980-12-01",
      "email": "email@email.com"
    }
  ]
}

Verification Request Fields

Properties

Schema NameDescription
businessName string
The business's name
minLength: 1
maxLength: 512
alternateBusinessName string
An alternate name for the business
minLength: 1
maxLength: 512
phone string
The business's phone
minLength: 1
maxLength: 32
identification identificationModel
A collection of official identifying information associated with an entity.
authorizedSigners [authorizedSigner]
An optional array of authorized signer entities
addresses [address]
An array of postal mailing addresses for this contact.
attributes object
An optional map of name/value pairs which provide additional metadata about the verification report.

address

{
  "label": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "st"
}

Address

Properties

Schema NameDescription
label string
A text label, suitable for presentation to the user. This is also used if type is other.
addressLine1 string (required)
The first street address line of the address, normally a house number and street name.
addressLine2 string
The optional second street address line of the address.
city string (required)
The name of the city or municipality.
regionCode string (required)
The mailing address region code, such as state in the US, or a province in Canada.
postalCode string (required)
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
countryCode string
The ISO 3166-1 country code.
minLength: 2
maxLength: 2

createVerificationReport

{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/verificationReports/v1.0.0/profile.json"
}

Create Verification Report

Properties

Schema NameDescription
Create Verification Report any
Representation used to create a new verification report.

allOf

Schema NameDescription
anonymous abstractResource
An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

and

Schema NameDescription
anonymous verificationRequestFields
Common fields of a verification request, used to build other model schemas.

verificationReportScoringSummary

{
  "transactionId": "string",
  "state": "passed",
  "businessVerifications": [
    {
      "value": "string",
      "description": "string"
    }
  ],
  "businessRiskFactors": [
    {
      "riskCode": "string",
      "description": "string"
    }
  ],
  "comprehensiveVerificationScores": [
    {
      "inputRepNumber": "string",
      "score": 0,
      "description": "string"
    }
  ],
  "authorizedRepresentativeRiskFactors": [
    {
      "riskCode": "string",
      "description": "string"
    }
  ]
}

Verification Report Summary

Properties

Schema NameDescription
transactionId string
The unique transactionId for this verification report used for tracking this verification report
state string
The state of a verification report. passed indicates that the Business was successfully verified based upon the supplied information, failed indicates it was not.
businessVerifications [businessVerificationScore]
[An score that summarizes the verification of the input information. This objects contains a score value and accompanying description.]
businessRiskFactors [riskFactor]
[Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.]
comprehensiveVerificationScores [comprehensiveVerificationScore]
[The comprehensive verification score is a risk verification score for the authorized representative]
authorizedRepresentativeRiskFactors [riskFactor]
[Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.]

Enumerated Values

Property Value
state passed
state failed

riskFactor

{
  "riskCode": "string",
  "description": "string"
}

Risk Factor

Properties

Schema NameDescription
riskCode string
The risk factor risk code
description string
The risk code description

comprehensiveVerificationScore

{
  "inputRepNumber": "string",
  "score": 0,
  "description": "string"
}

Authorized Representative Comprehensive Verification Score

Properties

Schema NameDescription
inputRepNumber string
the rep number for the authorized representative
score integer
The comprehensive verification score is a risk verification score of the authorized representative
description string
The description for the CVI value

businessVerificationScore

{
  "value": "string",
  "description": "string"
}

Business Verification Score

Properties

Schema NameDescription
value string
The business verification score value
description string
The business verification score description

summaryVerificationReport

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "http://api.apiture.com/schemas/businessVerifications/verificationReports/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Verification Report Summary

Properties

Schema NameDescription
Verification Report Summary any
Summary representation of a verification report resource in verification report collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

allOf

Schema NameDescription
anonymous abstractResource
An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

and

Schema NameDescription
anonymous object
undefined
_id string
The unique identifier for this verification report resource. This is an immutable opaque string.
reportScoringSummary verificationReportScoringSummary
Model schema for business verification report summary

verificationReport

{
  "createdAt": "2018-04-17T10:04:46.375Z",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_embedded": {},
  "input": {
    "businessName": "ABC EXAMPLE CO.",
    "phone": "555-555-1234",
    "identification": [
      {
        "type": "taxId",
        "value": "12-347894309"
      }
    ],
    "authorizedSigners": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "identification": [
          {
            "type": "taxId",
            "value": "121-34-5431"
          }
        ],
        "birthdate": "1980-12-01",
        "email": "email@email.com"
      }
    ],
    "addresses": [
      {
        "addressLine1": "3212 N. 2nd Ave.",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28412"
      }
    ]
  },
  "reportScoringSummary": {
    "transactionId": "578490325jk439834yuf43",
    "state": "failed",
    "businessVerification": [
      {
        "value": 40,
        "description": "Strong verification of the input data is confirmed"
      }
    ],
    "businessRiskFactors": [
      {
        "riskCode": "20",
        "description": "Unable to verify business address on business records"
      },
      {
        "riskCode": "21",
        "description": "Unable to verify business TIN on business records"
      }
    ],
    "comprehensiveVerificationScores": [
      {
        "inputRepNumber": "1",
        "score": 20,
        "description": "Full name, address, phone, SSN verified"
      }
    ],
    "authorizedRepresentativeRiskFactors": [
      {
        "riskCode": "81",
        "description": "The input date-of-birth was missing or incomplete"
      },
      {
        "riskCode": "25",
        "description": "Unable to verify address"
      }
    ]
  },
  "reportResults": {}
}

Verification Report

Properties

Schema NameDescription
Verification Report any
Representation of verification report resources.

allOf

Schema NameDescription
anonymous abstractResource
An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

and

Schema NameDescription
anonymous summaryVerificationReport
Summary representation of a verification report resource in verification report collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

and

Schema NameDescription
anonymous object
undefined
createdAt string(date-time)
An ISO 8601 UTC time stamp indicating when the verification report was created.
_embedded object
The objects which participate in this verification report
input createVerificationReport
Representation used to create a new verification report.
reportScoringSummary verificationReportScoringSummary
Model schema for business verification report summary
reportResults object
The raw verification report results

verificationReports

{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/verificationReports/v0.1.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "verificationReports",
  "_links": {
    "self": {
      "href": "/businessVerifications/verificationReports?start=10&limit=10"
    },
    "first": {
      "href": "/businessVerifications/verificationReports?start=0&limit=10"
    },
    "next": {
      "href": "/businessVerifications/verificationReports?start=20&limit=10"
    },
    "collection": {
      "href": "/businessVerifications/verificationReports"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "http://api.apiture.com/schemas/businessVerifications/verificationReports/v0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:organization": {
            "href": "/organizations/organizations/6734fdsa-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "reportScoringSummary": {
          "transactionId": "578490325jk439834yuf43",
          "state": "failed",
          "businessVerification": [
            {
              "value": 40,
              "description": "Strong verification of the input data is confirmed"
            }
          ],
          "businessRiskFactors": [
            {
              "riskCode": "20",
              "description": "Unable to verify business address on business records"
            },
            {
              "riskCode": "21",
              "description": "Unable to verify business TIN on business records"
            }
          ],
          "comprehensiveVerificationScores": [
            {
              "inputRepNumber": "1",
              "score": 20,
              "description": "Full name, address, phone, SSN verified"
            }
          ],
          "authorizedRepresentativeRiskFactors": [
            {
              "riskCode": "81",
              "description": "The input date-of-birth was missing or incomplete"
            },
            {
              "riskCode": "25",
              "description": "Unable to verify address"
            }
          ]
        }
      }
    ]
  }
}

Verification Report Collection

Properties

Schema NameDescription
Verification Report Collection any
Collection of verification reports. The items in the collection are ordered in the _embedded.items array; the name is verificationReports. The top-level _links object may contain pagination links (self, next, prev, first, last, collection.)

allOf

Schema NameDescription
anonymous collection
A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

and

Schema NameDescription
anonymous object
undefined
_embedded object
undefined
items [summaryVerificationReport]
An array containing a page of verification report items.

collection

{
  "_profile": "http://api.apiture.com/schemas/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    },
    "apiture:organization": {
      "href": "/organizations/organizations/6734fdsa-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string"
}

Collection

Properties

Schema NameDescription
Collection any
A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

allOf

Schema NameDescription
anonymous abstractResource
An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

and

Schema NameDescription
anonymous object
undefined
count integer
The number of items in the full collection..
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

authorizedSigner

{
  "firstName": "Jane",
  "lastName": "Doe",
  "identification": [
    {
      "type": "taxId",
      "value": "121-34-5431"
    }
  ],
  "birthdat>": "1980-12-01",
  "email": "email@email.com"
}

Authorized Signer

Properties

Schema NameDescription
firstName string (required)
The authorized signer's first name
minLength: 1
maxLength: 512
lastName string (required)
The authorized signer's last name
minLength: 1
maxLength: 512
identification identificationModel
A collection of official identifying information associated with an entity.
birthdate string(date)
The authorized signer's birth date in yyyy-mm-dd format.
minLength: 10
maxLength: 10
pattern: ^([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))$
email string
The authorized signer's email address
minLength: 1
maxLength: 512

identificationModel

[
  {
    "value": "string",
    "type": "taxId"
  }
]

A collection of official identifying information associated with an entity.

Properties

Schema NameDescription
value string (required)
The value of this form of identification (the tax ID as a string, for example)
type string (required)
The type of this form of identification. For a person, taxId is their federal tax ID (such as social security number). For a business, taxId is the Federal Employer Identification Number or FEIN (also known as Tax Identification Number or TIN), and dunsNumber is the business' Dun & Bradstreet Number.

Enumerated Values

Property Value
type taxId
type dunsNumber

businessVerification

{
  "state": "passed",
  "completedAt": "2019-02-20T12:18:25Z",
  "type": "verificationReport",
  "_id": "string",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  }
}

Business Verification Report

Properties

Schema NameDescription
state string
The state of a verification report. passed indicates that the Business was successfully verified based upon the supplied information, failed indicates it was not.
completedAt string(date-time)
An ISO 8601 UTC time stamp indicating when the verification report was created.
type string
The identity method type. Possible values are verificationReport or administratorApproval.
_id string
This business verification's unique id
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

Enumerated Values

Property Value
state passed
state failed
type verificationReport
type administratorApproval

businessVerifications

{
  "_profile": "http://api.apiture.com/schemas/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    },
    "apiture:organization": {
      "href": "/organizations/organizations/6734fdsa-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "businessVerifications": [
    {
      "state": "failed",
      "completedAt": "2018-04-17T10:04:46.375Z",
      "type": "verificationReport",
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_links": {
        "apiture:verificationReport": {
          "href": "/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    {
      "state": "passed",
      "completedAt": "2018-04-17T10:04:46.375Z",
      "type": "administratorApproval",
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_links": {
        "apiture:approval": {
          "href": "/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    }
  ]
}

Business Verifications

Properties

Schema NameDescription
Business Verifications any
Representation of the verification results that were previously generated by this service via the POST /businessVerifications. The result contains a link to apiture:organization if an apiture:organization link was passed on the request to create the report.

allOf

Schema NameDescription
anonymous abstractResource
An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

and

Schema NameDescription
anonymous object
undefined
businessVerifications [businessVerification]
An array of business verification resources

configuration

{
  "_links": {
    "self": {
      "href": "/businessVerifications/configuration/"
    },
    "apiture:groups": {
      "href": "/businessVerifications/configuration/groups"
    }
  }
}

Configuration

Properties

Schema NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

configurationGroups

{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/configurationGroups/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_links": {
    "self": {
      "href": "/businessVerifications/configuration/groups?start=10&limit=10"
    },
    "first": {
      "href": "/businessVerifications/configuration/groups?start=0&limit=10"
    },
    "next": {
      "href": "/businessVerifications/configuration/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/businessVerifications/configuration/groups"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "http://api.apiture.com/schemas/businessVerifications/configurationGroup/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/configuration/groups/rules"
          },
          "apiture:configuration": {
            "href": "/configuration"
          }
        },
        "name": "rules",
        "label": "Verification Rules",
        "description": "The basic pass-fail verification rules for the Business Verifications API"
      }
    ]
  }
}

Configuration Group Collection

Properties

Schema NameDescription
Configuration Group Collection any
Collection of configuration groups. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection.)

allOf

Schema NameDescription
anonymous abstractResource
An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

and

Schema NameDescription
anonymous object
undefined
_embedded object
undefined
items [configurationGroupSummary]
An array containing a page of configuration group items.

configurationGroupSummary

{
  "_profile": "http://api.apiture.com/schemas/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    },
    "apiture:organization": {
      "href": "/organizations/organizations/6734fdsa-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "name": "businessVerifications",
  "label": "Business Verifications Configuration",
  "description": "The configuration for the Business Verifications API."
}

Configuration Group Summary

Properties

Schema NameDescription
Configuration Group Summary any
A summary of the data contained within a configuration group resource

allOf

Schema NameDescription
anonymous abstractResource
An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

and

Schema NameDescription
anonymous object
undefined
name string
The name of this configuration group, must be unique within the set of all resources of this type.
minLength: 1
maxLength: 48
pattern: [a-zA-Z][-\w_]*
label string
The text label for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 128
description string
The full description for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 4096

configurationGroup

{
  "_profile": "http://api.apiture.com/schemas/businessVerifications/configurationGroup/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/configuration/groups/rules"
    },
    "apiture:configuration": {
      "href": "/configuration"
    }
  },
  "name": "rules",
  "label": "Verification Rules",
  "description": "The basic pass-fail verification rules for the Business Verifications API",
  "schema": {
    "type": "object",
    "properties": {
      "minBusinessVerificationScore": {
        "type": "string",
        "description": "The minimum pass score for Business Verification"
      },
      "minAuthRepVerificationScore": {
        "type": "string",
        "description": "The minimum pass score for Authorized Rep Verification"
      },
      "minCombinedVerificationScore": {
        "type": "string",
        "description": "The minimum combined Business and Rep Verification Score"
      },
      "autoFailBizRiskFactors": {
        "type": "string",
        "description": "Array of auto fail business risk factors"
      },
      "autoFailEntityRiskFactors": {
        "type": "string",
        "description": "Array of auto fail entity risk factors"
      }
    }
  },
  "values": {
    "minBusinessVerificationScore": "30",
    "minAuthRepVerificationScore": "30",
    "minCombinedVerificationScore": "70",
    "autoFailBizRiskFactors": "",
    "autoFailEntityRiskFactors": ""
  }
}

Configuration Group

Properties

Schema NameDescription
Configuration Group any
Represents a configuration group.

allOf

Schema NameDescription
anonymous configurationGroupSummary
A summary of the data contained within a configuration group resource

and

Schema NameDescription
anonymous object
undefined
schema configurationSchema
The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers consisting of alphanumeric characters, -, _ following the pattern letter [letter | digit | '-' | '_']* This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

values configurationValues
The data associated with this configuration: the resource's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. (For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.)

configurationSchema

{
  "type": "object",
  "properties": {
    "minBusinessVerificationScore": {
      "type": "string",
      "description": "The minimum pass score for Business Verification"
    },
    "minAuthRepVerificationScore": {
      "type": "string",
      "description": "The minimum pass score for Authorized Rep Verification"
    },
    "minCombinedVerificationScore": {
      "type": "string",
      "description": "The minimum combined Business and Rep Verification Score"
    },
    "autoFailBizRiskFactors": {
      "type": "string",
      "description": "Array of auto fail business risk factors"
    },
    "autoFailEntityRiskFactors": {
      "type": "string",
      "description": "Array of auto fail entity risk factors"
    }
  }
}

Configuration Schema

Properties

Schema NameDescription
Configuration Schema any
The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers consisting of alphanumeric characters, -, _ following the pattern letter [letter | digit | '-' | '_']* This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

configurationValues

{
  "minBusinessVerificationScore": "30",
  "minAuthRepVerificationScore": "30",
  "minCombinedVerificationScore": "70",
  "autoFailBizRiskFactors": "",
  "autoFailEntityRiskFactors": ""
}

Configuration Values

Properties

Schema NameDescription
Configuration Values any
The data associated with this configuration: the resource's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. (For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.)

abstractResource

{
  "_profile": "http://api.apiture.com/schemas/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    },
    "apiture:organization": {
      "href": "/organizations/organizations/6734fdsa-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Abstract Resource

Properties

Schema NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/root/v1.0.0/profile.json",
  "_links": {}
}

API Root

Properties

Schema NameDescription
API Root any
A HAL response, with hypermedia _links for the top-level resources and operations in API.

allOf

Schema NameDescription
anonymous abstractResource
An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

and

Schema NameDescription
anonymous object
undefined
_id string
This API's unique ID.
name string
This API's name.
apiVersion string
This API's version.

errorResponse

{
  "_profile": "http://api.apiture.com/schemas/error/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-02-20T12:18:18.833Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response

Properties

Schema NameDescription
Error Response abstractResource
Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

error

{
  "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
  "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
  "message": "The value for deposit must be greater than 0.",
  "statusCode": 422,
  "type": "positiveNumberRequired",
  "attributes": {
    "value": -125.5
  },
  "remediation": "Provide a value which is greater than 0",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "_links": {
    "describedby": {
      "href": "http://doc.apiture.com/errors/positiveNumberRequired"
    }
  },
  "_embedded": {
    "errors": []
  }
}

Error

Properties

Schema NameDescription
message string (required)
A localized message string describing the error condition.
_id string
A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string.
statusCode integer
The HTTP status code associate with this error.
minimum: 100
maximum: 599
type string
An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode. For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet.
occurredAt string(date-time)
An ISO 8601 UTC time stamp indicating when the error occurred.
attributes attributes
Data attribute associated with the error, such as values or constraints.
remediation string
An optional localized string which provides hints for how the user or client can resolve the error.
_embedded object
Optional embedded array of errors. This field may not exist if the error does not have nested errors.
items [errorResponse]
An array of error objects.

attributes

{}

Attributes

Properties

No properties

{
  "property1": {
    "href": "http://example.com",
    "type": "string",
    "templated": true,
    "title": "string",
    "deprecation": "http://example.com",
    "profile": "http://example.com"
  },
  "property2": {
    "href": "http://example.com",
    "type": "string",
    "templated": true,
    "title": "string",
    "deprecation": "http://example.com",
    "profile": "http://example.com"
  }
}

Links

Properties

Schema NameDescription
additionalProperties link
Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

{
  "href": "http://example.com",
  "type": "string",
  "templated": true,
  "title": "string",
  "deprecation": "http://example.com",
  "profile": "http://example.com"
}

Link

Properties

Schema NameDescription
href string(uri) (required)
The URI or URI template for the resource/operation this link refers to.
type string
The media type for the resource.
templated boolean
If true, the link's href is a URI template.
title string
An optional human-readable localized title for the link.
deprecation string(uri)
If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation.
profile string(uri)
The URI of a profile document, a JSON document which describes the target resource/operation.