Contacts v0.8.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.
Contacts manages contact information for people within the Apiture Banking APIs.
Download OpenAPI Definition (YAML)
Base URLs:
Authentication
- API Key (
apiKey
)- header parameter: API-Key
- API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the
API-Key: {api-key}
request header.
- OAuth2 authentication (
accessToken
)- OAuth2 client access token authentication. The client authenticates against the server at
authorizationUrl
, passing the client's privateclientId
(and optionalclientSecret
) as part of this flow. The client obtains an access token from the server attokenUrl
. It then passes the received access token via theAuthorization: Bearer {access-token}
header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires. - Flow:
authorizationCode
- Authorization URL = https://auth.apiture.com/oauth2/authorize
- Token URL = http://auth.apiture.com/auth/oauth2/token
- OAuth2 client access token authentication. The client authenticates against the server at
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 personally 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. |
API
Endpoints which describe this API.
getApi
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/contacts/ \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/contacts/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/contacts/',
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('https://api.devbank.apiture.com/contacts/',
{
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 'https://api.devbank.apiture.com/contacts/',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY'
}
r = requests.get('https://api.devbank.apiture.com/contacts/', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/");
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", "https://api.devbank.apiture.com/contacts/", 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. This API provides the following links in the _links
object:
apiture:contacts
-- links to thecontacts
collectionapiture:createContact
-- links to a POST operation to create a new contact
Example responses
200 Response
{
"id": "apiName",
"name": "API name",
"apiVersion": "1.0.0",
"_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
"_links": {}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: root |
getApiDoc
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/contacts/apiDoc \
-H 'Accept: application/json' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/contacts/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json
var headers = {
'Accept':'application/json',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/contacts/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('https://api.devbank.apiture.com/contacts/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 'https://api.devbank.apiture.com/contacts/apiDoc',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'API-Key': 'API_KEY'
}
r = requests.get('https://api.devbank.apiture.com/contacts/apiDoc', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/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", "https://api.devbank.apiture.com/contacts/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.
Example responses
200 Response
{}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: Inline |
Response Schema
getLabels
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/contacts/labels \
-H 'Accept: application/hal+json' \
-H 'Accept-Language: string' \
-H 'API-Key: API_KEY'
GET https://api.devbank.apiture.com/contacts/labels HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
Accept-Language: string
var headers = {
'Accept':'application/hal+json',
'Accept-Language':'string',
'API-Key':'API_KEY'
};
$.ajax({
url: 'https://api.devbank.apiture.com/contacts/labels',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'Accept-Language':'string',
'API-Key':'API_KEY'
};
fetch('https://api.devbank.apiture.com/contacts/labels',
{
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',
'Accept-Language' => 'string',
'API-Key' => 'API_KEY'
}
result = RestClient.get 'https://api.devbank.apiture.com/contacts/labels',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'Accept-Language': 'string',
'API-Key': 'API_KEY'
}
r = requests.get('https://api.devbank.apiture.com/contacts/labels', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/labels");
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"},
"Accept-Language": []string{"string"},
"API-Key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/contacts/labels", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Localized Labels
GET /labels
Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API.
The labels in the response may not all match the
requested language; some may be in the default
language (en-us
).
Parameters
Parameter | Description |
---|---|
Accept-Language (header) |
string The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per RFC 7231. |
Example responses
200 Response
{
"property1": {
"label": "Limited Liability Corporation",
"description": "string",
"language": "en-us",
"code": "31"
},
"property2": {
"label": "Limited Liability Corporation",
"description": "string",
"language": "en-us",
"code": "31"
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: localizedLabels |
Contact
Contact data for individuals.
getContacts
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/contacts/contacts \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/contacts/contacts HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
var headers = {
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/contacts/contacts',
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('https://api.devbank.apiture.com/contacts/contacts',
{
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 'https://api.devbank.apiture.com/contacts/contacts',
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('https://api.devbank.apiture.com/contacts/contacts', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/contacts");
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", "https://api.devbank.apiture.com/contacts/contacts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Return a collection of contacts
GET /contacts
Return a paginated sortable filterable searchable collection of contacts. The links in the response include pagination links.
Parameters
Parameter | Description |
---|---|
start (query) |
integer(int64) The zero-based index of the first contact item to include in this page. The default 0 denotes the beginning of the collection. |
limit (query) |
integer(int32) The maximum number of contact 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. |
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/contacts/contacts/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"name": "contacts",
"_links": {
"self": {
"href": "/contacts/contacts?start=10&limit=10"
},
"first": {
"href": "/contacts/contacts?start=0&limit=10"
},
"next": {
"href": "/contacts/contacts?start=20&limit=10"
},
"collection": {
"href": "/contacts/contacts"
}
},
"_embedded": {
"items": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "pe1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "we1",
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"_id": "hp1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "mp1",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active"
}
]
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: contacts | |
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 |
createContact
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/contacts/contacts \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/contacts/contacts HTTP/1.1
Host: api.devbank.apiture.com
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: 'https://api.devbank.apiture.com/contacts/contacts',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active"
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/contacts/contacts',
{
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 'https://api.devbank.apiture.com/contacts/contacts',
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('https://api.devbank.apiture.com/contacts/contacts', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/contacts");
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", "https://api.devbank.apiture.com/contacts/contacts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new contact
POST /contacts
Create a new contact in the contacts collection.
Body parameter
{
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active"
}
Parameters
Parameter | Description |
---|---|
body (body) |
createContact (required) The data necessary to create a new contact. |
Example responses
201 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Responses
Status | Description |
---|---|
201 | Created |
Created | |
Schema: contact | |
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
Status | Description |
---|---|
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. |
getContact
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/contacts/contacts/{contactId} \
-H 'Accept: application/hal+json' \
-H 'If-None-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/contacts/contacts/{contactId} HTTP/1.1
Host: api.devbank.apiture.com
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: 'https://api.devbank.apiture.com/contacts/contacts/{contactId}',
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('https://api.devbank.apiture.com/contacts/contacts/{contactId}',
{
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 'https://api.devbank.apiture.com/contacts/contacts/{contactId}',
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('https://api.devbank.apiture.com/contacts/contacts/{contactId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/contacts/{contactId}");
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", "https://api.devbank.apiture.com/contacts/contacts/{contactId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this contact
GET /contacts/{contactId}
Return a HAL representation of this contact resource.
Parameters
Parameter | Description |
---|---|
contactId (path) |
string (required) The unique identifier of this contact. 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. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: contact | |
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 contact resource at the specified {contactId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
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 contact resource. |
updateContact
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/contacts/contacts/{contactId} \
-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 https://api.devbank.apiture.com/contacts/contacts/{contactId} HTTP/1.1
Host: api.devbank.apiture.com
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: 'https://api.devbank.apiture.com/contacts/contacts/{contactId}',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/contacts/contacts/{contactId}',
{
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 'https://api.devbank.apiture.com/contacts/contacts/{contactId}',
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('https://api.devbank.apiture.com/contacts/contacts/{contactId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/contacts/{contactId}");
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", "https://api.devbank.apiture.com/contacts/contacts/{contactId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this contact
PUT /contacts/{contactId}
Perform a complete replacement of this contact.
Body parameter
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Parameters
Parameter | Description |
---|---|
contactId (path) |
string (required) The unique identifier of this contact. This is an opaque string. |
If-Match (header) |
string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
body (body) |
contact (required) |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: contact | |
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 contact resource at the specified {contactId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse | |
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 | |
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 |
Response Headers
Status | Description |
---|---|
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 contact resource. |
patchContact
Code samples
# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/contacts/contacts/{contactId} \
-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}'
PATCH https://api.devbank.apiture.com/contacts/contacts/{contactId} HTTP/1.1
Host: api.devbank.apiture.com
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: 'https://api.devbank.apiture.com/contacts/contacts/{contactId}',
method: 'patch',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/contacts/contacts/{contactId}',
{
method: 'PATCH',
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.patch 'https://api.devbank.apiture.com/contacts/contacts/{contactId}',
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.patch('https://api.devbank.apiture.com/contacts/contacts/{contactId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/contacts/{contactId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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("PATCH", "https://api.devbank.apiture.com/contacts/contacts/{contactId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Update this contact
PATCH /contacts/{contactId}
Perform a partial update of this contact. Fields which are omitted are not updated. Nested _embedded
and _links
are ignored if included.
Body parameter
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Parameters
Parameter | Description |
---|---|
contactId (path) |
string (required) The unique identifier of this contact. This is an opaque string. |
If-Match (header) |
string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
state (query) |
string Subset the accounts or external accounts collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending will match only items whose state is pending ; ?state=removed|inactive will match items whose state is removed or inactive . This is combined with an implicit and with other filters if they are used. See filtering. Enumerated values: pending active inactive removed |
occupation (query) |
string Subset the accounts or external accounts collection to those with this name value. Use |
body (body) |
contact (required) |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: contact | |
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 contact resource at the specified {contactId} . The _error field in the response will contain details about the request error. | |
Schema: errorResponse | |
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 | |
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 |
Response Headers
Status | Description |
---|---|
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 contact resource. |
activateContact
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/contacts/activeContacts?contact=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/contacts/activeContacts?contact=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/contacts/activeContacts',
method: 'post',
data: '?contact=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/contacts/activeContacts?contact=string',
{
method: 'POST',
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-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/contacts/activeContacts',
params: {
'contact' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/contacts/activeContacts', params={
'contact': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/activeContacts?contact=string");
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{
"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("POST", "https://api.devbank.apiture.com/contacts/activeContacts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Activate a contact.
POST /activeContacts
Activate a contact from an inactive state.
This operation is invoked from the apiture:activate
link on a contact resource when that contact is eligible to be activated. This operation is only allowed if the state is inactive
.
This changes the state
to active
.
Parameters
Parameter | Description |
---|---|
contact (query) |
string (required) A string which identifies an existing contact to activate, deactivate, or remove by POST ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a {contactId} or a contact URI. |
contactUri (query) |
string The URI of an existing contact which is eligible to be activated. This parameter is deprecated. Use the ?contact= query parameter instead. |
If-Match (header) |
string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: contact | |
400 | Bad Request |
Bad Request. The contact or contactUri was malformed or does not refer to a contact. | |
Schema: errorResponse | |
409 | Conflict |
Conflict. There is no such contact resource at the specified
| |
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 |
Response Headers
Status | Description |
---|---|
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 contact resource. |
deactivateContact
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/contacts/inactiveContacts?contact=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/contacts/inactiveContacts?contact=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/contacts/inactiveContacts',
method: 'post',
data: '?contact=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/contacts/inactiveContacts?contact=string',
{
method: 'POST',
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-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/contacts/inactiveContacts',
params: {
'contact' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/contacts/inactiveContacts', params={
'contact': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/inactiveContacts?contact=string");
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{
"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("POST", "https://api.devbank.apiture.com/contacts/inactiveContacts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Deactivate a contact.
POST /inactiveContacts
Deactivate a contact from an active state.
This operation is invoked from the apiture:deactivate
link on a contact resource when that contact is eligible to be deactivated. This operation is only allowed if the state is active
.
This changes the state
to inactive
.
Parameters
Parameter | Description |
---|---|
contact (query) |
string (required) A string which identifies an existing contact to activate, deactivate, or remove by POST ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a {contactId} or a contact URI. |
contactUri (query) |
string The URI of an existing contact which is eligible to be activated. This parameter is deprecated. Use the ?contact= query parameter instead. |
If-Match (header) |
string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: contact | |
400 | Bad Request |
Bad Request. The contact or contactUri was malformed or does not refer to a contact. | |
Schema: errorResponse | |
409 | Conflict |
Conflict. There is no such contact resource at the specified
| |
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 |
Response Headers
Status | Description |
---|---|
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 contact resource. |
removeContact
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/contacts/removedContacts?contact=string \
-H 'Accept: application/hal+json' \
-H 'If-Match: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/contacts/removedContacts?contact=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string
var headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/contacts/removedContacts',
method: 'post',
data: '?contact=string',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const headers = {
'Accept':'application/hal+json',
'If-Match':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/contacts/removedContacts?contact=string',
{
method: 'POST',
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-Match' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/contacts/removedContacts',
params: {
'contact' => 'string'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'If-Match': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/contacts/removedContacts', params={
'contact': 'string'
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/contacts/removedContacts?contact=string");
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{
"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("POST", "https://api.devbank.apiture.com/contacts/removedContacts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Remove a contact.
POST /removedContacts
Remove a contact by setting its state to removed
.
This operation is invoked from the apiture:remove
link on a contact resource when that contact is eligible to be removed. The contact must not be in use (there may not be any active associations to the contact). This operation is only allowed if the state is inactive
.
This changes the state
to removed
.
Parameters
Parameter | Description |
---|---|
contact (query) |
string (required) A string which identifies an existing contact to activate, deactivate, or remove by POST ing it to the corresponding resource set. The server supplies this value in a link within the representation of a contact. The value may be a {contactId} or a contact URI. |
contactUri (query) |
string The URI of an existing contact which is eligible to be activated. This parameter is deprecated. Use the ?contact= query parameter instead. |
If-Match (header) |
string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource. |
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: contact | |
400 | Bad Request |
Bad Request. The contact or contactUri was malformed or does not refer to a contact. | |
Schema: errorResponse | |
409 | Conflict |
Conflict. There is no such contact resource at the specified
| |
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 |
Response Headers
Status | Description |
---|---|
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 contact resource. |
Schemas
kycAnswers
{
"foreignPoliticalFigure": false,
"foreignPoliticalFigureCountry": "st",
"foreignPoliticalFigureAssociation": "unknown"
}
Know Your Customer Answers
Answers to 'Know Your Customer' questions which allow financial institutions to conform to a customer identification program.
Properties
Name | Description |
---|---|
foreignPoliticalFigure | boolean true if the person is a foreign senior political figure.
|
foreignPoliticalFigureCountry | string If the person is a foreign senior political figure, this is the foreign country ISO 3166-1 country code. This field is omitted if foreignPoliticalFigure is false .
maxLength: 2
|
foreignPoliticalFigureAssociation | string The type of association to a foreign political figure.
|
identification
{
"type": "taxId",
"value": "111-11-1111",
"expiration": {}
}
Identification
Official identifying information associated with the contact.
Properties
Name | Description |
---|---|
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.
|
expiration | string(date) The date when the form of identification expires, in RFC 3339 YYYY-MM-DD format.
|
authorization
{
"type": "joint",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "111-11-1111",
"citizen": true,
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"id": "wa0",
"type": "other",
"label": "mailing",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha5",
"emailAddress": "JohnDanielSmith@example.com"
}
Authorization
Represents a person authorized for account access. This object contains key identification information for the person and the type of access or role that the person has in relation to the banking account or organization.
Properties
Name | Description |
---|---|
firstName | string (required) The person's first name (or given name). |
middleName | string The person's middle name. |
lastName | string (required) The person's last name (or surname). |
addresses | [address] (required) An array of postal/mailing addresses. |
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
|
taxId | string (required) Official government identification (tax ID) for this person. |
citizen | boolean (required) Indicates if the person is a (US) citizen. |
emailAddress | string(email) Optional email address. |
type | string (required) The type of this account access authorization.
|
simpleContact
{
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"emailAddresses": [
{
"id": "pe0",
"value": "api@apiture.com",
"type": "personal"
},
{
"id": "wp1",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "pe0",
"phones": [
{
"_id": "hp1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "mp1",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneNumberId": "hp1"
}
Simple Contact
Basic contact and identification information for a person, consisting of the name, mailing address, phone numbers, email addresses, and government identification.
Properties
Name | Description |
---|---|
firstName | string The person's first name (or given name). |
middleName | string The person's middle name. |
lastName | string The person's last name (or surname). |
addresses | [address] An array of postal/mailing addresses. |
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
|
emailAddresses | [typedEmailAddress] An array of email addresses. |
preferredEmailAddressId | string The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
|
phones | [phoneNumber] An array of phone numbers. |
preferredPhoneId | string The ID of preferred phone number. This string is the _id of a phone number in the phones array.
minLength: 1
maxLength: 4
|
prefix | string A title or honorific prefix such as Dr. or Fr. maxLength: 20
|
suffix | string A title or honorific suffix such as PhD or DDS. maxLength: 20
|
preferredName | string The contact's preferred name. This is how the contact's name is presented to the user in the interface. The default is the contact's firstName .
|
identification | [identification] A collection of official identifying information associated with the contact. |
citizenship
[
{
"countryCode": "US",
"state": "citizen"
}
]
Citizenship
Citizenship or nationality status.
Properties
Name | Description |
---|---|
countryCode | string (required) The ISO 3166-1 country code for the individual's citizenship. minLength: 2
maxLength: 2
|
state | string (required) The individual's citizenship status.
|
occupation
"unknown"
Occupation
The person's occupation.
Type: string
Enumerated values: unknown
academia
architecture
artsDesign
buildingServices
businessAndFinancialOperations
childCare
communityAndSocialServices
computer
construction
education
energy
engineering
entertainment
farming
fishing
foodService
forestry
healthcare
hospitality
installationMaintenanceRepair
legal
localGovernment
management
media
military
nationalGovernment
nonProfit
officeAndAdministrationSupport
personalCare
production
protectiveServices
research
sales
sciences
sports
stateGovernment
technology
tourism
trade
transportation
notApplicable
unemployed
other
phoneNumber
{
"_id": "hp1",
"type": "home",
"number": "555-555-5555"
}
Phone Number
A phone number and its role.
Properties
Name | Description |
---|---|
type | string (required) The type or role of this phone number.
|
number | string (required) The phone number, as a string. |
label | string A text label, suitable for presentation to the end user. This is also used if type is other .
|
_id | string An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array.
minLength: 1
maxLength: 8
|
employmentStatus
"unknown"
Employment Status
The employment status of a contact, located in kycAnswers
.
Type: string
Enumerated values: unknown
fullTime
partTime
paidLeave
retired
selfEmployed
notEmployed
disabled
homemaker
other
notApplicable
typedEmailAddress
{
"value": "JohnBankCustomer@example.com",
"type": "unknown",
"_id": "ha3"
}
Email Address
An email address and the email address type.
Properties
Name | Description |
---|---|
value | string(email) The email address, such as JohnBankCustomer@example.com
minLength: 8
maxLength: 120
|
type | string The kind of email address this is.
|
_id | string An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array.
minLength: 1
maxLength: 8
|
address
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
Address
A postal address.
Properties
Name | Description |
---|---|
type | string (required) The type of this address.
|
label | string A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other
read-only |
otherType | string The actual address type if type is other .
minLength: 4
maxLength: 32
|
addressLine1 | string 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 The name of the city or municipality. |
regionCode | string The mailing address region code, such as state in the US, or a province in Canada. |
postalCode | string 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
|
_id | string An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array.
minLength: 1
maxLength: 8
|
createContact
{
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active"
}
Create Contact
Representation used to create a new contact.
Properties
Name | Description |
---|---|
kycAnswers | object An object that contains the answers to kyc questions. These will be toggle-able and configurable in the future. |
identityVerificationStatus | string The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. read-only
|
state | string The state of this person.
|
firstName | string The person's first name (or given name). |
middleName | string The person's middle name. |
lastName | string (required) The person's last name (or surname). |
addresses | [address] An array of postal/mailing addresses. |
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
|
emailAddresses | [typedEmailAddress] An array of email addresses. |
preferredEmailAddressId | string The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
|
phones | [phoneNumber] An array of phone numbers. |
preferredPhoneId | string The ID of preferred phone number. This string is the _id of a phone number in the phones array.
minLength: 1
maxLength: 4
|
prefix | string A title or honorific prefix such as Dr. or Fr. maxLength: 20
|
suffix | string A title or honorific suffix such as PhD or DDS. maxLength: 20
|
preferredName | string The contact's preferred name. This is how the contact's name is presented to the user in the interface. The default is the contact's firstName .
|
identification | [identification] A collection of official identifying information associated with the contact. |
birthdate | string(date) The contact's birth date in YYYY-MM-DD format.
|
citizenship | citizenship This individual's citizenship or nationality status. |
occupation | occupation The occupation of this individual. |
otherOccupation | string The actual occupation of this individual if their occupation is other . This is ignored if occupation is not other .
minLength: 4
maxLength: 32
|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» 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.
|
_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. |
attributes | object An optional map of name/value pairs which provide additional metadata about the contact. |
summaryContact
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Contact Summary
Summary representation of a contact resource in contacts 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.
Properties
Name | Description |
---|---|
kycAnswers | object An object that contains the answers to kyc questions. These will be toggle-able and configurable in the future. |
identityVerificationStatus | string The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. read-only
|
state | string The state of this person.
|
firstName | string The person's first name (or given name). |
middleName | string The person's middle name. |
lastName | string The person's last name (or surname). |
addresses | [address] An array of postal/mailing addresses. |
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
|
emailAddresses | [typedEmailAddress] An array of email addresses. |
preferredEmailAddressId | string The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
|
phones | [phoneNumber] An array of phone numbers. |
preferredPhoneId | string The ID of preferred phone number. This string is the _id of a phone number in the phones array.
minLength: 1
maxLength: 4
|
prefix | string A title or honorific prefix such as Dr. or Fr. maxLength: 20
|
suffix | string A title or honorific suffix such as PhD or DDS. maxLength: 20
|
preferredName | string The contact's preferred name. This is how the contact's name is presented to the user in the interface. The default is the contact's firstName .
|
identification | [identification] A collection of official identifying information associated with the contact. |
birthdate | string(date) The contact's birth date in YYYY-MM-DD format.
|
citizenship | citizenship This individual's citizenship or nationality status. |
occupation | occupation The occupation of this individual. |
otherOccupation | string The actual occupation of this individual if their occupation is other . This is ignored if occupation is not other .
minLength: 4
maxLength: 32
|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» 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.
|
_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. |
_id | string The unique identifier for this contact resource. This is an immutable opaque string. |
contact
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "ea1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "ek3",
"value": "support@apiture.com",
"type": "work"
}
],
"preferredEmailAddressId": "ea1",
"phones": [
{
"_id": "pa1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "da6",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"preferredPhoneId": "pa1",
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha1",
"identityVerificationStatus": "verified",
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active",
"createdAt": "2018-04-17T10:04:46.375Z",
"updatedAt": "2018-04-17T10:12:58.375Z",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
},
"apiture:deactivate": {
"href": "/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
}
}
}
Contact
Representation of a contact resource. Contact data (mailing addresses, phone numbers, email addresses) for an individual.
Properties
Name | Description |
---|---|
kycAnswers | object An object that contains the answers to kyc questions. These will be toggle-able and configurable in the future. |
identityVerificationStatus | string The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record. read-only
|
state | string The state of this person.
|
firstName | string The person's first name (or given name). |
middleName | string The person's middle name. |
lastName | string The person's last name (or surname). |
addresses | [address] An array of postal/mailing addresses. |
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
|
emailAddresses | [typedEmailAddress] An array of email addresses. |
preferredEmailAddressId | string The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
|
phones | [phoneNumber] An array of phone numbers. |
preferredPhoneId | string The ID of preferred phone number. This string is the _id of a phone number in the phones array.
minLength: 1
maxLength: 4
|
prefix | string A title or honorific prefix such as Dr. or Fr. maxLength: 20
|
suffix | string A title or honorific suffix such as PhD or DDS. maxLength: 20
|
preferredName | string The contact's preferred name. This is how the contact's name is presented to the user in the interface. The default is the contact's firstName .
|
identification | [identification] A collection of official identifying information associated with the contact. |
birthdate | string(date) The contact's birth date in YYYY-MM-DD format.
|
citizenship | citizenship This individual's citizenship or nationality status. |
occupation | occupation The occupation of this individual. |
otherOccupation | string The actual occupation of this individual if their occupation is other . This is ignored if occupation is not other .
minLength: 4
maxLength: 32
|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» 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.
|
_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. |
_id | string The unique identifier for this contact resource. This is an immutable opaque string. |
attributes | object An optional map of name/value pairs which provide additional metadata about the contact. |
createdAt | string(date-time) The date-time when the contact was created. |
updatedAt | string(date-time) The date-time when the contact was updated |
contacts
{
"_profile": "https://api.apiture.com/schemas/contacts/contacts/v1.0.0/profile.json",
"start": 10,
"limit": 10,
"count": 67,
"name": "contacts",
"_links": {
"self": {
"href": "/contacts/contacts?start=10&limit=10"
},
"first": {
"href": "/contacts/contacts?start=0&limit=10"
},
"next": {
"href": "/contacts/contacts?start=20&limit=10"
},
"collection": {
"href": "/contacts/contacts"
}
},
"_embedded": {
"items": [
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"_profile": "https://api.apiture.com/schemas/contacts/contact/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
}
},
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"preferredName": "John",
"suffix": "MD",
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
],
"emailAddresses": [
{
"_id": "pe1",
"value": "api@apiture.com",
"type": "personal"
},
{
"_id": "we1",
"value": "support@apiture.com",
"type": "work"
}
],
"phones": [
{
"_id": "hp1",
"type": "home",
"number": "(555) 555-5555"
},
{
"_id": "mp1",
"type": "mobile",
"number": "(999) 555-5555"
}
],
"birthdate": "1974-10-27",
"citizenship": [
{
"countryCode": "US",
"state": "citizen"
}
],
"occupation": "Software Engineer",
"addresses": [
{
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"yearsAtAddress": 3,
"mailingDifferentAddress": false,
"kycAnswers": {
"citizen": true,
"permanentResident": true,
"w9Withholdings": false,
"employmentStatus": "employed",
"occupation": "Software Engineer",
"foreignPoliticalFigure": false,
"countryPoliticalFigure": "N/A",
"familyOfPoliticalFigure": false
},
"state": "active"
}
]
}
}
Contact Collection
Collection of contacts. The items in the collection are ordered in the _embedded.items
array; the name
is contacts
. The top-level _links
object may contain pagination links such as self
, next
, prev
, first
, last
, collection
.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» 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.
|
_embedded | object Embedded objects. |
» items | [summaryContact] An array containing a page of contact items. |
_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. |
count | integer The number of items in the collection. This value is optional and my be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter. |
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. |
root
{
"id": "apiName",
"name": "API name",
"apiVersion": "1.0.0",
"_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
"_links": {}
}
API Root
A HAL response, with hypermedia _links
for the top-level resources and operations in API.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» 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.
|
_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. |
_id | string This API's unique ID. |
name | string This API's name. |
apiVersion | string This API's version. |
localizedLabels
{
"property1": {
"label": "Limited Liability Corporation",
"description": "string",
"language": "en-us",
"code": "31"
},
"property2": {
"label": "Limited Liability Corporation",
"description": "string",
"language": "en-us",
"code": "31"
}
}
Localized Labels
A map that defines lables for an enumeration or other item in a JSON schema. This is a map which maps enumeration schema names to an localizedLabel
object.
Properties
Name | Description |
---|---|
additionalProperties | localizedLabel A localized label and optional description for localizable content defined in this API. |
errorResponse
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
"_error": {
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"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": "https://api.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
}
Error Response
Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error
object contains the error details.
Properties
Name | Description |
---|---|
_links | object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
» 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.
|
_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. |
localizedLabel
{
"label": "Limited Liability Corporation",
"description": "string",
"language": "en-us",
"code": "31"
}
Localized Label
A localized label and optional description for localizable content defined in this API.
Properties
Name | Description |
---|---|
label | string A localized label or title which may be used labels or other UI controls which present a value. |
description | string A more detailed localized description of a localizable label. |
language | string The actual natural language tag to which this localized label is associated, as per RFC 7231 |
code | string If the localized value is associated with an external standard, this is a lookup code or key or URI for that value. |
link
{
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
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.
Properties
Name | Description |
---|---|
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. |
error
{
"_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
"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": "https://developer.apiture.com/errors/positiveNumberRequired"
}
},
"_embedded": {
"errors": []
}
}
Error
Describes an error in an API request or in a service called via the API.
Properties
Name | Description |
---|---|
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 RFC 3339 UTC time stamp indicating when the error occurred. |
attributes | attributes Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the minimum and maximum values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error type .
|
remediation | string An optional localized string which provides hints for how the user or client can resolve the error. |
_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 Embedded objects. An error object may contain nested errors. For example, an API which validates its request body may find multiple errors in the request, which are returned with an error response with nested errors. These are held in an items array of errorResponse objects. _embedded or _embedded.items may not exist if the error does not have nested errors.
|
» items | [errorResponse] An array of error objects. |
attributes
{}
Attributes
An optional map of name/value pairs which contains additional dynamic data about the resource.
Properties
links
{
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
}
Links
An optional map of links, mapping each link relation to a link object. This model defines the _links
object of HAL representations.
Properties
Name | Description |
---|---|
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.
|