Partner Organizations v0.13.2

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

Client and partner organizations (businesses, financial institutions etc.) which register on the Apiture Developer portal for API keys.

Download OpenAPI Definition (YAML)

Base URLs:

• /partners

Terms of service

Email: Apiture Web: Apiture

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 private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: 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 = /auth/oauth2/authorize
  • Token URL = /auth/oauth2/token

Scope	Scope Description
profiles/read	Read access to partner related resources.
profiles/write	Write (update) access to partner related resources.
admin/delete	Administrator delete access to partner 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 partner related resources.

Partner Organization

Partner Organization

getOrganizations

Code samples

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

GET /partners/organizations HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/partners/organizations',
  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('/partners/organizations',
{
  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 '/partners/organizations',
  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('/partners/organizations', params={

}, headers = headers)

print r.json()

URL obj = new URL("/partners/organizations");
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", "/partners/organizations", data)
    req.Header = headers

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

Return a collection of organizations

GET /organizations

Return a paginated filterable collection of organizations. The links in the response include pagination links. The result is limited to partner organizations that the caller has access to (usually, their own partner organization) based on their email address domain. (Admin users have access to all partner organizations.)

Parameters

Parameter	Description
start (query)	string Represents the first record of the page of results. This is supplied by the service when paginating items: the next link includes a ?start= query parameter which refers to beginning of the next page of items.
limit (query)	integer(int32) The maximum number of organization representations to return in this page. Default: 100
filter (query)	string Optional filter criteria. See filtering.
domain (query)	string Subset the result to match only partner organizations whose domain property matches this value. This is combined with the filter query, if any, via and implicit and. Note that for most users, the collection is already implicitly filtered to their organization.
type (query)	string Subset the organizations collection to those with this exact type value. Use
state (query)	array[string] Subset the resources to only those whose state matches the query, such as ?state=active. The value may be a | separated list of states, such as ?state=pending|active to match all resources whose state is either pending or active. If ?filter= is also used, the two are combined with an implicit and() operation.
name (query)	string Subset the organizations collection to those with this name value. Use

Try It

Example responses

200 Response

{
  "start": "g434ljkf430",
  "limit": 10,
  "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/organizations/organizations?start=g434ljkf430&limit=10"
    },
    "next": {
      "href": "/organizations/organizations?start=p4900sk3df9&limit=10"
    },
    "collection": {
      "href": "/organizations/organizations"
    }
  },
  "count": 10,
  "name": "organizations",
  "_embedded": {
    "items": {
      "anyOf": [
        {
          "_id": "331af113-8f7b-422d-89fe-d0489cc43e5d",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/331af113-8f7b-422d-89fe-d0489cc43e5d"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b-422d-89fe-d0489cc43e5d"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "trust",
          "state": "pending"
        },
        {
          "_id": "a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "nonprofit",
          "state": "pending"
        },
        {
          "_id": "0c748e89-3180-4d43-927d-5120d39b4fa8",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/0c748e89-3180-4d43-927d-5120d39b4fa8"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=0c748e89-3180-4d43-927d-5120d39b4fa8"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "nonprofit",
          "state": "pending"
        },
        {
          "_id": "fb602721-ac57-4d68-835d-f649e351e2b5",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/fb602721-ac57-4d68-835d-f649e351e2b5"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=fb602721-ac57-4d68-835d-f649e351e2b5"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "nonprofit",
          "state": "pending"
        },
        {
          "_id": "64b636ec-cebe-44bc-9962-d4de2329abe3",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/64b636ec-cebe-44bc-9962-d4de2329abe3"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=64b636ec-cebe-44bc-9962-d4de2329abe3"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "municipality",
          "state": "pending"
        },
        {
          "_id": "c161edaa-293f-4c01-a232-e9a14344b297",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/c161edaa-293f-4c01-a232-e9a14344b297"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=c161edaa-293f-4c01-a232-e9a14344b297"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "nonprofit",
          "state": "pending"
        },
        {
          "_id": "2b094e5d-d2a7-4a03-8110-64ac9ac457e6",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
            }
          },
          "name": "example corporation",
          "label": "",
          "type": "corporation",
          "state": "pending"
        },
        {
          "_id": "ccaea92d-5ba0-4f30-a39f-a422ad02e7ad",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
            }
          },
          "name": "example llc",
          "label": "",
          "type": "llc",
          "state": "pending"
        },
        {
          "_id": "43f53a1f-7d00-443b-87ee-04f0704ffb14",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/43f53a1f-7d00-443b-87ee-04f0704ffb14"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=43f53a1f-7d00-443b-87ee-04f0704ffb14"
            }
          },
          "name": "example partnership",
          "label": "",
          "type": "partnership",
          "state": "pending"
        },
        {
          "_id": "741fee0e-7f94-4d30-9fd7-62a318768d23",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/741fee0e-7f94-4d30-9fd7-62a318768d23"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=741fee0e-7f94-4d30-9fd7-62a318768d23"
            }
          },
          "name": "example llp",
          "label": "",
          "type": "llp",
          "state": "pending"
        }
      ]
    }
  }
}

Responses

createOrganization

Code samples

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

POST /partners/organizations HTTP/1.1

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

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

};

$.ajax({
  url: '/partners/organizations',
  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/organizations/organization/v1.0.0/profile.json"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/partners/organizations',
{
  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 '/partners/organizations',
  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('/partners/organizations', params={

}, headers = headers)

print r.json()

URL obj = new URL("/partners/organizations");
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", "/partners/organizations", data)
    req.Header = headers

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

Create a new organization

POST /organizations

Create a new organization in the organizations collection.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json"
}

Parameters

Parameter	Description
body (body)	createOrganization (required) The data necessary to create a new organization.

Try It

Example responses

201 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

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.

getOrganization

Code samples

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

GET /partners/organizations/{organizationId} HTTP/1.1

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

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

};

$.ajax({
  url: '/partners/organizations/{organizationId}',
  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('/partners/organizations/{organizationId}',
{
  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 '/partners/organizations/{organizationId}',
  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('/partners/organizations/{organizationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/partners/organizations/{organizationId}");
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", "/partners/organizations/{organizationId}", data)
    req.Header = headers

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

Fetch a representation of this organization

GET /organizations/{organizationId}

Return a HAL representation of this organization resource. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)

Parameters

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

Try It

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

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 organization resource.

updateOrganization

Code samples

# You can also use wget
curl -X PUT /partners/organizations/{organizationId} \
  -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 /partners/organizations/{organizationId} HTTP/1.1

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

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

};

$.ajax({
  url: '/partners/organizations/{organizationId}',
  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/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/partners/organizations/{organizationId}',
{
  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 '/partners/organizations/{organizationId}',
  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('/partners/organizations/{organizationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/partners/organizations/{organizationId}");
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", "/partners/organizations/{organizationId}", data)
    req.Header = headers

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

Update this organization

PUT /organizations/{organizationId}

Perform a complete replacement of this organization. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)

Body parameter

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Parameters

Parameter	Description
organizationId (path)	string (required) The unique identifier of this organization. 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)	organization (required)

Try It

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

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 organization resource.

patchOrganization

Code samples

# You can also use wget
curl -X PATCH /partners/organizations/{organizationId} \
  -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 /partners/organizations/{organizationId} HTTP/1.1

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

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

};

$.ajax({
  url: '/partners/organizations/{organizationId}',
  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/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/partners/organizations/{organizationId}',
{
  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 '/partners/organizations/{organizationId}',
  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('/partners/organizations/{organizationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/partners/organizations/{organizationId}");
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", "/partners/organizations/{organizationId}", data)
    req.Header = headers

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

Update this organization

PATCH /organizations/{organizationId}

Perform a partial update of this organization. Fields which are omitted are not updated. Nested _embedded and _links are ignored if included. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)

Body parameter

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Parameters

Parameter	Description
organizationId (path)	string (required) The unique identifier of this organization. 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)	organization (required)

Try It

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

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 organization resource.

deleteOrganization

Code samples

# You can also use wget
curl -X DELETE /partners/organizations/{organizationId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE /partners/organizations/{organizationId} HTTP/1.1

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: '/partners/organizations/{organizationId}',
  method: 'delete',

  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('/partners/organizations/{organizationId}',
{
  method: 'DELETE',

  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.delete '/partners/organizations/{organizationId}',
  params: {
  }, 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.delete('/partners/organizations/{organizationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/partners/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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("DELETE", "/partners/organizations/{organizationId}", data)
    req.Header = headers

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

Delete this organization resource

DELETE /organizations/{organizationId}

Delete this organization resource. Most callers do not have delete access. (Admin users have delete access to all partner organizations.)

Parameters

Parameter	Description
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
organizationId (path)	string (required) The unique identifier of this organization. This is an opaque string.

Try It

Example responses

403 Response

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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": []
    }
  }
}

Responses

inviteMembers

Code samples

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

POST /partners/organizations/{organizationId}/memberInvitations HTTP/1.1

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

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

};

$.ajax({
  url: '/partners/organizations/{organizationId}/memberInvitations',
  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/partnerOrganizations/createInvitation/v1.0.0/profile.json",
  "message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
  "invitees": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "emailAddress": "john.smith@example.com"
    }
  ]
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/partners/organizations/{organizationId}/memberInvitations',
{
  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 '/partners/organizations/{organizationId}/memberInvitations',
  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('/partners/organizations/{organizationId}/memberInvitations', params={

}, headers = headers)

print r.json()

URL obj = new URL("/partners/organizations/{organizationId}/memberInvitations");
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", "/partners/organizations/{organizationId}/memberInvitations", data)
    req.Header = headers

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

Invite new members

POST /organizations/{organizationId}/memberInvitations

Invite new members to this partner organization. This operation sends the invitees an invitation email. This API does not track which people it has sent invitations to; it unconditionally emails each invitee even if they have been invited in the past or are already registered. When the recipients register on the developer portal with an email address with the same partner domain, they are automatically added to the organization.

TODO: Provide API to remove members (i.e. if they leave the organization.)

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/partnerOrganizations/createInvitation/v1.0.0/profile.json",
  "message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
  "invitees": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "emailAddress": "john.smith@example.com"
    }
  ]
}

Parameters

Parameter	Description
organizationId (path)	string (required) The unique identifier of this organization. This is an opaque string.
body (body)	createInvitation (required) The data necessary to invite one or more new members.

Try It

Example responses

202 Response

{
  "_profile": "https://api.apiture.com/schemas/partnerOrganizations/invitation/v1.0.0/profile.json",
  "message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
  "invitees": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "emailAddress": "john.smith@example.com"
    }
  ]
}

Responses

activateOrganization

Code samples

# You can also use wget
curl -X POST /partners/activeOrganizations?organization=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /partners/activeOrganizations?organization=string HTTP/1.1

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: '/partners/activeOrganizations',
  method: 'post',
  data: '?organization=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('/partners/activeOrganizations?organization=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 '/partners/activeOrganizations',
  params: {
  'organization' => '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('/partners/activeOrganizations', params={
  'organization': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/partners/activeOrganizations?organization=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", "/partners/activeOrganizations", data)
    req.Header = headers

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

Activate a partner organization.

POST /activeOrganizations

Activate a partner organization from an inactive state.

This operation is invoked from the apiture:activate link on an organization resource when that partner resource is eligible to be activated.

This changes the state to active.

Parameters

Parameter	Description
organization (query)	string (required) A string which identifies existing organization whose state is being changed by POSTing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI.
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

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 partner organization resource.

deactivateOrganization

Code samples

# You can also use wget
curl -X POST /partners/inactiveOrganizations?organization=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /partners/inactiveOrganizations?organization=string HTTP/1.1

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: '/partners/inactiveOrganizations',
  method: 'post',
  data: '?organization=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('/partners/inactiveOrganizations?organization=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 '/partners/inactiveOrganizations',
  params: {
  'organization' => '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('/partners/inactiveOrganizations', params={
  'organization': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/partners/inactiveOrganizations?organization=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", "/partners/inactiveOrganizations", data)
    req.Header = headers

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

Deactivate a partner organization.

POST /inactiveOrganizations

Deactivate a partner organization from an active state.

This operation is invoked from the apiture:deactivate link on an organization resource when that partner organization is eligible to be deactivated.

This changes the state to inactive.

Parameters

Parameter	Description
organization (query)	string (required) A string which identifies existing organization whose state is being changed by POSTing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI.
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

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 partner organization resource.

removeOrganization

Code samples

# You can also use wget
curl -X POST /partners/removedOrganizations?organization=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /partners/removedOrganizations?organization=string HTTP/1.1

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: '/partners/removedOrganizations',
  method: 'post',
  data: '?organization=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('/partners/removedOrganizations?organization=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 '/partners/removedOrganizations',
  params: {
  'organization' => '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('/partners/removedOrganizations', params={
  'organization': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/partners/removedOrganizations?organization=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", "/partners/removedOrganizations", data)
    req.Header = headers

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

Remove a partner organization.

POST /removedOrganizations

Remove a partner organization by setting its state to removed.

This operation is invoked from the apiture:remove link on a organization resource when that resource is eligible to be removed. The organization must not be in use (there may not be any active associations to the organization).

This changes the state to removed.

Parameters

Parameter	Description
organization (query)	string (required) A string which identifies existing organization whose state is being changed by POSTing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI.
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

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 partner organization resource.

validatePartnerDomain

Code samples

# You can also use wget
curl -X GET /partners/domainValidations?domain=string \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET /partners/domainValidations?domain=string HTTP/1.1

Accept: application/hal+json

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

};

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

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

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

};

fetch('/partners/domainValidations?domain=string',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/partners/domainValidations',
  params: {
  'domain' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('/partners/domainValidations', params={
  'domain': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/partners/domainValidations?domain=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

Validate a partner domain name

GET /domainValidations

Check if a partner domain is valid. Some domains are not valid for use in the developer portal, such as those assocated with generic email services (gmail.com, outlook.com, yahoo.com, aol.com, and so on). The domain is passed as a query parameter. The 200 response is a JSON object, and the _error will be populated if the domain is not valid.

Parameters

Parameter	Description
domain (query)	string (required) A candidate partner domain, such as example.com or apiture.com. This is typically taked from the user's email address, following the @ character.

Try It

Example responses

200 Response

{
  "_links": {
    "property1": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Application"
    },
    "property2": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Application"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "valid": true
}

Responses

API

Endpoints which describe this API.

getApi

Code samples

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

GET /partners/ HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/partners/',
  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('/partners/',
{
  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 '/partners/',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("/partners/");
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", "/partners/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET /

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

Try It

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json",
  "_links": {}
}

Responses

getApiDoc

Code samples

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

GET /partners/apiDoc HTTP/1.1

Accept: application/json

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

};

$.ajax({
  url: '/partners/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('/partners/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 '/partners/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("/partners/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", "/partners/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try It

Example responses

200 Response

{}

Responses

Response Schema

getLabels

Code samples

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

GET /partners/labels HTTP/1.1

Accept: application/hal+json
Accept-Language: string

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

};

$.ajax({
  url: '/partners/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('/partners/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 '/partners/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('/partners/labels', params={

}, headers = headers)

print r.json()

URL obj = new URL("/partners/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", "/partners/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.

Try It

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

Schemas

abstractRequest

{
  "_profile": "https://api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/"
    }
  }
}

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Abstract Resource (v2.0.0)

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

Properties

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

address

{
  "_id": "ha5",
  "type": "home",
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US"
}

Address (v1.0.0)

A postal address with the address type and an identifier.

Properties

Name	Description
addressLine1	string The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128
addressLine2	string The optional second street address line of the address. maxLength: 128
city	string The name of the city or municipality. minLength: 2 maxLength: 128
regionCode	string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: ^[0-9]{5}(?:-[0-9]{4})?$
countryCode	string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
type	addressType (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 minLength: 4 maxLength: 32
otherType	string The actual address type if type is other. minLength: 4 maxLength: 32
_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 pattern: ^[-a-zA-Z0-9_]{1,8}$

addressType

"unknown"

Address Type (v1.0.0)

The type of a postal address.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named addressType in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
home
prior
work
school
mailing
vacation
shipping
billing
headquarters
commercial
site
property
other
notApplicable

attributeValue

{}

Attribute Value (v2.0.0)

The data associated with this attribute.

Properties

attributes

{
  "property1": {},
  "property2": {}
}

Attributes (v2.0.0)

An optional map of name/value pairs which contains additional dynamic data about the resource.

Properties

Name	Description
additionalProperties	attributeValue The data associated with this attribute.

createInvitation

{
  "_profile": "https://api.apiture.com/schemas/partnerOrganizations/createInvitation/v1.0.0/profile.json",
  "message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
  "invitees": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "emailAddress": "john.smith@example.com"
    }
  ]
}

Create Invitation

Representation used to create an invitation to join a partner organization.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
message	string(markdown) (required) An invitation message from the inviter to includ in the invitation email. The message is Markdown which can be formatted with rich text. minLength: 16 maxLength: 512
invitees	[invitee] (required) The list of invitees. minItems: 1 maxItems: 16

createOrganization

{
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json"
}

Create Partner Organization

Representation used to create a new organization.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
name	string (required) The organization's official full name
label	string The organization's common name.
type	organizationType Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation.
subtype	organizationSubtype A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.
identification	[organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID.
addresses	[organizationAddress] An array containing address items.
phones	[organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
emailAddresses	[organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
preferredEmailAddressId	string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
preferredPhoneId	string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
establishedDate	string(date) The date the organization was established.
state	organizationState The state of this partner organization.
homeUrl	string(uri) The organization's home page. maxLength: 512
attributes	object An optional map of name/value pairs which provide additional metadata about the organization.

cursorPagedCollection

{
  "_links": {
    "property1": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Application"
    },
    "property2": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Application"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "start": "string",
  "limit": 0,
  "name": "string"
}

Cursor Paged Collection (v2.0.0)

A collection of resources, or a page from a larger collection. This is an abstract model schema which is extended to define specific resource collections. Pages are referenced using an opaque string starting point named start. The _links in the collection may contain pagination links:

• the next link returns the next page of items. If there is no next link, the collection has been exhausted.
• the first link returns to the beginning of the filtered/sorted collection.
• the collection link returns to the beginning of the default collection with no explicit filter or sort criteria.

Cursor paged collections can only paginate forwards contiguously (without skipping items or pages), or reset to the beginning of the collection. This pagination works for collections which are likely to change during pagination, such as adding data to the beginning of the collection's natural sort order. Examples include transactions or audit records.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
start	string An opaque marker representing the position of the current page in this resource collection. The service will use the start and limit to compute the ?start= query parameter for the next page when it provides the next link in the collection's _links.
limit	integer The maximum number of items per page.
name	string A name for the items in collection.

domainValidation

{
  "_links": {
    "property1": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Application"
    },
    "property2": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Application"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "valid": true
}

Domain Validation

The response from validating a partner domain.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
valid	boolean true if the domain is valid, false if not. If false, consult the _error object.

emailType

"unknown"

Email Type (v1.0.0)

The kind of email address.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named emailType in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
personal
work
school
other
notApplicable

error

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": [
    {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  ],
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Error (v2.0.0)

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. read-only
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.
errors	[error] An optional array of nested error objects. This property is not always present.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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 (v2.0.0)

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

invitation

{
  "_profile": "https://api.apiture.com/schemas/partnerOrganizations/invitation/v1.0.0/profile.json",
  "message": "I am inviting you to join our partner organization on the Apiture Developer Portal.",
  "invitees": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "emailAddress": "john.smith@example.com"
    }
  ]
}

Member Invitation

Partner Organization member invitation.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
message	string(markdown) (required) An invitation message from the inviter to includ in the invitation email. The message is Markdown which can be formatted with rich text. minLength: 16 maxLength: 512
invitees	[invitee] (required) The list of invitees. minItems: 1 maxItems: 16

invitee

{
  "firstName": "John",
  "lastName": "Smith",
  "emailAddress": "john.smith@example.com"
}

Invitee

Representation of new partner organization member invitee.

Properties

Name	Description
firstName	string (required) The first name of the invitee. maxLength: 64
lastName	string (required) The last name of the invitee. maxLength: 64
emailAddress	string (required) The email address of the invitee. maxLength: 128

link

{
  "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Application"
}

Link (v1.0.0)

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.

links

{
  "property1": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  },
  "property2": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  }
}

Links (v1.0.0)

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.

localizedLabel

{
  "label": "Limited Liability Corporation",
  "description": "string",
  "language": "en-us",
  "code": "31"
}

Localized Label (v1.0.0)

A localized label and optional description for localizable content defined in this API. This schema is deprecated; use labelItem instead.

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.

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 (v1.0.0)

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. This schema is deprecated. Use labelGroups` instead.

Properties

Name	Description
additionalProperties	localizedLabel A localized label and optional description for localizable content defined in this API. This schema is deprecated; use labelItem instead.

organization

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Partner Organization

Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for a partner organization. a partner organization may have the following links in the _links object:

• apiture:activate - Activate a new, pending organization.
• apiture:deactivate - Deactivate a partner organization (if it is active).
• apiture:remove - Remove an inactive organization.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
name	string The organization's official full name
label	string The organization's common name.
type	organizationType Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation.
subtype	organizationSubtype A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.
identification	[organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID.
addresses	[organizationAddress] An array containing address items.
phones	[organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
emailAddresses	[organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
preferredEmailAddressId	string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
preferredPhoneId	string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
establishedDate	string(date) The date the organization was established.
state	organizationState The state of this partner organization.
homeUrl	string(uri) The organization's home page. maxLength: 512
_id	string The unique identifier for this organization resource. This is an immutable opaque string.
domain	string This partner organization's internet domain name. This is derived from the domain name of email address of the first user that registers with the organizations email domain. The dev portal adds other user's to the partner organization that matches their verified email address domain. read-only
attributes	object An optional map of name/value pairs which provide additional metadata about the organization.
createdAt	string(date-time) The date-time when the organization was created.
updatedAt	string(date-time) The date-time when the organization was updated

organizationAddress

{
  "_id": "ha1",
  "type": "home",
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
    }
  }
}

Organization Address (v1.0.0)

Representation of an organization's address resource.

Links

Response and request bodies using this organizationAddress schema may contain the following links:

Rel	Summary	Method
delete	Delete this address resource	DELETE
apiture:setAsPreferred	Set Preferred mailing Address	PUT

Properties

Name	Description
addressLine1	string The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128
addressLine2	string The optional second street address line of the address. maxLength: 128
city	string The name of the city or municipality. minLength: 2 maxLength: 128
regionCode	string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: ^[0-9]{5}(?:-[0-9]{4})?$
countryCode	string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
type	addressType (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 minLength: 4 maxLength: 32
otherType	string The actual address type if type is other. minLength: 4 maxLength: 32
_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 pattern: ^[-a-zA-Z0-9_]{1,8}$
state	profileItemState The state of this address. pending addresses require financial institution approval. Only approved addresses may be set as the preferred address.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.

organizationEmailAddress

{
  "_id": "pe1",
  "_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
  "type": "personal",
  "number": "+19105550155",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
    },
    "delete": {
      "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
    }
  }
}

Email Address (v1.0.0)

Representation of email address resources. An email address is immutable, although organizations can add new email addresses.

Links

Response and request bodies using this organizationEmailAddress schema may contain the following links:

Rel	Summary	Method
delete	Delete this email address resource	DELETE
apiture:setAsPreferred	Set Preferred Email Address	PUT

Properties

Name	Description
value	string(email) The email address, such as JohnBankCustomer@example.com minLength: 8 maxLength: 120
type	emailType The kind of email address.
_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 pattern: ^[-a-zA-Z0-9_]{1,8}$
state	profileItemState The state of this email address. pending email addresses require financial institution approval. Only approved numbers may be set as the preferred email address.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.

organizationFields

{
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": [
    {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "we0"
    }
  ],
  "phones": [
    {
      "type": "work",
      "number": "(555) 555-5555",
      "_id": "wp0"
    },
    {
      "type": "mobile",
      "number": "(999) 555-5555",
      "_id": "mp0"
    }
  ],
  "addresses": [
    {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US",
      "_id": "wa0"
    },
    {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "_id": "wa0"
    }
  ],
  "state": "active",
  "establishedDate": {}
}

Partner Organization Fields

Common fields of the organization resource used to build other model schemas.

Properties

Name	Description
name	string The organization's official full name
label	string The organization's common name.
type	organizationType Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation.
subtype	organizationSubtype A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.
identification	[organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID.
addresses	[organizationAddress] An array containing address items.
phones	[organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
emailAddresses	[organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
preferredEmailAddressId	string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
preferredPhoneId	string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
establishedDate	string(date) The date the organization was established.
state	organizationState The state of this partner organization.
homeUrl	string(uri) The organization's home page. maxLength: 512

organizationIdentification

{
  "value": "string",
  "type": "taxId",
  "expiresOn": "2019-08-24",
  "expiration": "2019-08-24"
}

Organization Identification

The type and value of the organizations unique identification numbers.

Properties

Name	Description
value	string (required) The value of this form of identification (the tax ID as a string, for example)
type	organizationIdentificationType (required) The type of this form of identification. taxId is the only supported type at this time.
expiresOn	string(date) The date when this form of identification expires.
expiration	string(date) The date when this form of identification expires. Note This property is deprecated; use expiresOn.

organizationIdentificationType

"taxId"

Organization Identification Type (v1.0.0)

The type of the form of an organization's identification. taxId is the only supported type at this time.

organizationIdentificationType strings may have one of the following enumerated values:

Value	Description
taxId	Tax Identification Number: The company's federal Tax Identification Number. This is also known as the Employer Identification Number or EIN in the US. It may be the owner's SSN for a sole proprietorship.
dunsNumber	Dun & Bradstreet D-U-N-S Number: Dun & Bradstreet D-U-N-S Number, a unique nine-digit identifier for businesses.

These enumeration values are further described by the label group named organizationIdentificationType in the response from the getLabels operation.

Type: string
Enumerated values:
taxId
dunsNumber

organizationPhoneNumber

{
  "_id": "hp1",
  "_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
  "type": "home",
  "number": "555-555-5555",
  "state": "approved",
  "_links": {
    "self": {
      "href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  }
}

Phone Number

Representation of phone number resources.

Properties

Name	Description
type	phoneNumberType (required) The type or role of this phone number.
number	string (required) The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. minLength: 8 maxLength: 20
label	string A text label, suitable for presentation to the end user. This is also used if type is other. maxLength: 32
_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 pattern: ^[-a-zA-Z0-9_]{1,8}$
state	profileItemState The state of this phone number. pending numbers require financial institution approval. Only approved numbers may be set as the preferred phone number.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.

organizationState

"pending"

Partner Organization State

The state of this partner organization.

Type: string
Enumerated values:
pending
inactive
active
removed

organizationSubtype

"string"

Organization Subtype (v1.0.0)

A refinement of the organization type.

The allowed values for this property are defined at runtime in the label group named organizationSubtype in the response from the getLabels operation.

Properties

organizationType

"string"

Organization Type (v1.0.0)

The primary organization type.

The allowed values for this property are defined at runtime in the label group named organizationType in the response from the getLabels operation.

Properties

organizations

{
  "start": "g434ljkf430",
  "limit": 10,
  "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/organizations/organizations?start=g434ljkf430&limit=10"
    },
    "next": {
      "href": "/organizations/organizations?start=p4900sk3df9&limit=10"
    },
    "collection": {
      "href": "/organizations/organizations"
    }
  },
  "count": 10,
  "name": "organizations",
  "_embedded": {
    "items": {
      "anyOf": [
        {
          "_id": "331af113-8f7b-422d-89fe-d0489cc43e5d",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/331af113-8f7b-422d-89fe-d0489cc43e5d"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b-422d-89fe-d0489cc43e5d"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "trust",
          "state": "pending"
        },
        {
          "_id": "a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "nonprofit",
          "state": "pending"
        },
        {
          "_id": "0c748e89-3180-4d43-927d-5120d39b4fa8",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/0c748e89-3180-4d43-927d-5120d39b4fa8"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=0c748e89-3180-4d43-927d-5120d39b4fa8"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "nonprofit",
          "state": "pending"
        },
        {
          "_id": "fb602721-ac57-4d68-835d-f649e351e2b5",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/fb602721-ac57-4d68-835d-f649e351e2b5"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=fb602721-ac57-4d68-835d-f649e351e2b5"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "nonprofit",
          "state": "pending"
        },
        {
          "_id": "64b636ec-cebe-44bc-9962-d4de2329abe3",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/64b636ec-cebe-44bc-9962-d4de2329abe3"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=64b636ec-cebe-44bc-9962-d4de2329abe3"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "municipality",
          "state": "pending"
        },
        {
          "_id": "c161edaa-293f-4c01-a232-e9a14344b297",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/c161edaa-293f-4c01-a232-e9a14344b297"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=c161edaa-293f-4c01-a232-e9a14344b297"
            }
          },
          "name": "Apiture",
          "label": "",
          "type": "nonprofit",
          "state": "pending"
        },
        {
          "_id": "2b094e5d-d2a7-4a03-8110-64ac9ac457e6",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
            }
          },
          "name": "example corporation",
          "label": "",
          "type": "corporation",
          "state": "pending"
        },
        {
          "_id": "ccaea92d-5ba0-4f30-a39f-a422ad02e7ad",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
            }
          },
          "name": "example llc",
          "label": "",
          "type": "llc",
          "state": "pending"
        },
        {
          "_id": "43f53a1f-7d00-443b-87ee-04f0704ffb14",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/43f53a1f-7d00-443b-87ee-04f0704ffb14"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=43f53a1f-7d00-443b-87ee-04f0704ffb14"
            }
          },
          "name": "example partnership",
          "label": "",
          "type": "partnership",
          "state": "pending"
        },
        {
          "_id": "741fee0e-7f94-4d30-9fd7-62a318768d23",
          "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "https://api.apiture.com/organizations/organizations/741fee0e-7f94-4d30-9fd7-62a318768d23"
            },
            "apiture:activate": {
              "href": "https://api.apiture.com/organizations/activeOrganizations?organization=741fee0e-7f94-4d30-9fd7-62a318768d23"
            }
          },
          "name": "example llp",
          "label": "",
          "type": "llp",
          "state": "pending"
        }
      ]
    }
  }
}

Partner Organization Collection

Collection of organizations. The items in the collection are ordered in the _embedded.items array; the name is organizations. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

Name	Description
_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.
» items	[summaryOrganization] An array containing a page of organization 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.
start	string An opaque marker representing the position of the current page in this resource collection. The service will use the start and limit to compute the ?start= query parameter for the next page when it provides the next link in the collection's _links.
limit	integer The maximum number of items per page.
name	string A name for the items in collection.

phoneNumber

{
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155"
}

Phone Number (v1.0.0)

A phone number and its role.

Properties

Name	Description
type	phoneNumberType (required) The type or role of this phone number.
number	string (required) The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. minLength: 8 maxLength: 20
label	string A text label, suitable for presentation to the end user. This is also used if type is other. maxLength: 32
_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 pattern: ^[-a-zA-Z0-9_]{1,8}$

phoneNumberType

"unknown"

Phone Number Type (v1.0.0)

The type or role of this phone number.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named phoneNumberType in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
home
work
mobile
fax
other

profileItemState

"approved"

Organization Profile Item State (v1.0.0)

The state of an item (address, email address, or phone number) within the organization's profile. New addresses, email addresses, or phone numbers start with the state pending, which means approval by the financial institution is pending. After they have been verified, the state becomes approved. Some normalizing or sanitizing of the value may occur when this happens (for example, a ZIP code may change to ZIP+4 format). pending items may not be assigned as the preferred item.

profileItemState strings may have one of the following enumerated values:

Value	Description
pending	Pending: A profile item that the financial institution has not yet approved.
approved	Approved: A profile item that the financial institution has approved.

These enumeration values are further described by the label group named profileItemState in the response from the getLabels operation.

Type: string
Enumerated values:
pending
approved

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json",
  "_links": {}
}

API Root (v2.0.0)

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

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
_id	string This API's unique ID. read-only
name	string This API's name.
apiVersion	string This API's version.

simpleAddress

{
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US"
}

Simple Address (v1.0.0)

A postal address.

Properties

Name	Description
addressLine1	string The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128
addressLine2	string The optional second street address line of the address. maxLength: 128
city	string The name of the city or municipality. minLength: 2 maxLength: 128
regionCode	string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: ^[0-9]{5}(?:-[0-9]{4})?$
countryCode	string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: ^[a-zA-Z]{2}$

simpleOrganization

{
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": [
    {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  ],
  "identification": [
    {
      "type": "taxId",
      "value": "00-9999999"
    }
  ],
  "phones": [
    {
      "type": "work",
      "number": "(555) 555-5555"
    },
    {
      "type": "mobile",
      "number": "(999) 555-5555"
    }
  ],
  "addresses": [
    {
      "type": "work",
      "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"
    }
  ],
  "establishedDate": "2009-07-09T"
}

Simple Organization

The simplest form of an organization.

Properties

Name	Description
name	string The organization's official full name
label	string The organization's common name.
type	organizationType Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation.
subtype	organizationSubtype A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.
identification	[organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID.
addresses	[organizationAddress] An array containing address items.
phones	[organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
emailAddresses	[organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
preferredEmailAddressId	string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
preferredPhoneId	string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
establishedDate	string(date) The date the organization was established.

summaryOrganization

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

Partner Organization Summary

Summary representation of a partner organization resource in organizations 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
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
name	string The organization's official full name
label	string The organization's common name.
type	organizationType Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation.
subtype	organizationSubtype A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.
identification	[organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID.
addresses	[organizationAddress] An array containing address items.
phones	[organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
emailAddresses	[organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
preferredEmailAddressId	string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation. read-only minLength: 1 maxLength: 4
preferredPhoneId	string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation. read-only minLength: 1 maxLength: 4
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation. read-only minLength: 1 maxLength: 4
establishedDate	string(date) The date the organization was established.
state	organizationState The state of this partner organization.
homeUrl	string(uri) The organization's home page. maxLength: 512
_id	string The unique identifier for this organization resource. This is an immutable opaque string.
domain	string This partner organization's internet domain name. This is derived from the domain name of email address of the first user that registers with the organizations email domain. The dev portal adds other user's to the partner organization that matches their verified email address domain. read-only

typedEmailAddress

{
  "value": "JohnBankCustomer@example.com",
  "type": "unknown",
  "_id": "ha3"
}

Email Address (v1.0.0)

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	emailType The kind of email address.
_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 pattern: ^[-a-zA-Z0-9_]{1,8}$