Invitations v0.7.1

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

This API allows digital banking customers to send invitations to other people to become joint owners on personal accounts or to become authorized signers of business organizations.

When a user creates a new invitation (createInvitation below), the service sends an email, on behalf of the financial institution, to the invitee's email address with instructions to accept the invitation by visiting a web page. The link in the generated email includes parameters that describe the invitation resource, including but not limited to invitationId. The invitationId is required on the verifyInvitation operation below.

The "shared secret" is a string the invitee shares the inviter to verify their identity. See (sharedSecret below)

Invitation States may be one of the following:

• sent Invitation sent to invitee
• accepted Invitation accepted by invitee
• completed Invitee has been added to their invited role
• revoked Invitation revoked by inviter
• expired Invitation expired

The invitation also references the account or organization they are being invited to join, depending on the type of the invitation. For joint owner invitations, other existing joint owners on the account can see outstanding invitations for the account. For authorized signer invitation, other existing joint owners can see outstanding invitations for the business organization.

The Inviter should share the secret with the invitee through another secure channel (such as face to face or in a phone conversation) so that unauthorized people cannot accept the invitation.

The Inviter can revoke an invitation if the state of the invitation is sent.

When the invitee visits the web form listed in their invitation email, they enter the sharedSecret to accept. The client can use the verifyInvitation operation below to determine if the invitee entered the secret correctly. If they enter the data correctly, the invitation is accepted.

If not already users, invitees must register as users on the financial institution's digital banking platform in order to assume these roles. Unverified users must also execute the financial institution's identity verification process before they are added as a joint user or authorized signer. Once added as a joint user or authorized signer, the invitation is completed.

Inviters can update an invitation's shared secret. Inviters can also request an invitation be resent, or they can revoke an invitation. Unaccepted invitations expire after some time (such as 30 or 45 days).

Error Types

Error responses in this API may have one of the type values described below. See Errors for more information on error responses and error types.

jointOwnersDisabled

Description: Co-owners are not supported in this account.
Remediation: Contact your financial institution.

verificationInvitationExpired

Description: The invitation you are attempting to accept is expired.
Remediation: Check to ensure that you are following the latest invitation email or contact your inviter.

verificationInvitationNotRevokable

Description: The invitation you are attempting to revoke is not in the sent state.
Remediation: Only invitations in the sent state can be revoked. One cannot revoke an invitation after it has expired, been accepted, or is completed.

verificationInvitationRevoked

Description: The invitation you are attempting to accept is revoked.
Remediation: Check to ensure that you are following the latest invitation email or contact your inviter.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.devbank.apiture.com/invitations

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 = https://auth.devbank.apiture.com/auth/oauth2/authorize
  • Token URL = https://api.devbank.apiture.com/auth/oauth2/token

API

The Invitations API

getLabels

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/invitations/labels \
  -H 'Accept: application/hal+json' \
  -H 'Accept-Language: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/invitations/labels HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
Accept-Language: string

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

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

};

fetch('https://api.devbank.apiture.com/invitations/labels',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/labels',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/invitations/labels',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/invitations/labels', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/invitations/labels", data)
    req.Header = headers

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

Localized Labels

GET https://api.devbank.apiture.com/invitations/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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "fristGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Responses

getApi

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/invitations/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/invitations/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/invitations/',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/invitations/',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/invitations/', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/invitations/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET https://api.devbank.apiture.com/invitations/

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/invitations/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/invitations/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json

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

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

};

fetch('https://api.devbank.apiture.com/invitations/apiDoc',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/apiDoc',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/invitations/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/invitations/apiDoc', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/invitations/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET https://api.devbank.apiture.com/invitations/apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

Invitation

Invitations

getInvitations

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/invitations/invitations \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/invitations/invitations HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/invitations/invitations',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/invitations',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/invitations/invitations',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/invitations/invitations', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/invitations/invitations", data)
    req.Header = headers

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

Return a collection of invitations

GET https://api.devbank.apiture.com/invitations/invitations

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

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/invitations/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/invitations/invitations?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/invitations/invitations?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/invitations/invitations?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/invitations/invitations"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "invitations",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "firstName": "Max",
        "lastName": "Peck",
        "identification": "3333",
        "sharedSecret": "obsolete obese octopus",
        "emailAddress": "Max.Peck@nasa.example.com",
        "type": "joint",
        "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
        "inviterFullName": "Maxine Peck",
        "state": "sent",
        "verificationCount": 0,
        "createdBy": "maxinepeck123",
        "createdAt": "2019-01-20T05:54:52.375Z",
        "expiresAt": "2019-02-20T05:54:52.375Z",
        "customerId": "57212",
        "customerGroup": "2",
        "_profile": "https://production.api.apiture.com/schemas/invitations/invitation/v1.2.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/invitations/invitation/2dce7016-0059-46d0-92fa-aed853b80c10"
          }
        }
      }
    ]
  }
}

Responses

createInvitation

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/invitations/invitations \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/invitations/invitations HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/invitations/createInvitation/v2.2.0/profile.json",
  "_links": {},
  "sharedSecret": "obsolete obese octopus",
  "type": "productPromotion",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/invitations/invitations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/invitations',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/invitations/invitations',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/invitations/invitations', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/invitations/invitations", data)
    req.Header = headers

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

Create a new invitation

POST https://api.devbank.apiture.com/invitations/invitations

Create a new invitation resource and send the invitation email to the invitee.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/createInvitation/v2.2.0/profile.json",
  "_links": {},
  "sharedSecret": "obsolete obese octopus",
  "type": "productPromotion",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}

Parameters

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/invitation/v1.2.0/profile.json",
  "sharedSecret": "obsolete obese octopus",
  "type": "joint",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/invitations/invitation/2dce7016-0059-46d0-92fa-aed853b80c10"
    },
    "apiture:acceptInvitationUserExperience": {
      "href": "https://devbank.apiture.com/accceptProductInvitation?invitationId=2dce7016-0059-46d0-92fa-aed853b80c10"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "state": "sent",
  "verificationCount": 0,
  "createdBy": "maxinepeck123",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "expiresAt": "2019-02-20T05:54:52.375Z",
  "customerId": "57212",
  "customerGroup": "2",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}

Responses

getInvitation

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/invitations/invitations/{invitationId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/invitations/invitations/{invitationId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/invitations/invitations/{invitationId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/invitations/{invitationId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/invitations/invitations/{invitationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/invitations/invitations/{invitationId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/invitations/invitations/{invitationId}", data)
    req.Header = headers

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

Fetch a representation of this invitation

GET https://api.devbank.apiture.com/invitations/invitations/{invitationId}

Return a HAL representation of this invitation resource.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/invitation/v1.2.0/profile.json",
  "sharedSecret": "obsolete obese octopus",
  "type": "joint",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/invitations/invitation/2dce7016-0059-46d0-92fa-aed853b80c10"
    },
    "apiture:acceptInvitationUserExperience": {
      "href": "https://devbank.apiture.com/accceptProductInvitation?invitationId=2dce7016-0059-46d0-92fa-aed853b80c10"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "state": "sent",
  "verificationCount": 0,
  "createdBy": "maxinepeck123",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "expiresAt": "2019-02-20T05:54:52.375Z",
  "customerId": "57212",
  "customerGroup": "2",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}

Responses

deleteInvitation

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/invitations/invitations/{invitationId} \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/invitations/invitations/{invitationId} HTTP/1.1
Host: api.devbank.apiture.com

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

const headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/invitations/invitations/{invitationId}',
{
  method: 'DELETE',

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

var headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/invitations/{invitationId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

headers = {
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/invitations/invitations/{invitationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/invitations/invitations/{invitationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/invitations/invitations/{invitationId}");
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{
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/invitations/invitations/{invitationId}", data)
    req.Header = headers

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

Delete this invitation resource

DELETE https://api.devbank.apiture.com/invitations/invitations/{invitationId}

Delete this invitation resource and any resources that are owned by it.

Parameters

Responses

revokeInvitation

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/invitations/revoked?invitation=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/invitations/revoked?invitation=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/invitations/revoked?invitation=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/revoked',
  method: 'post',
  data: '?invitation=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/invitations/revoked',
  params: {
  'invitation' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/invitations/revoked', params={
  'invitation': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/invitations/revoked?invitation=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/invitations/revoked", data)
    req.Header = headers

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

Revoke an Invitation

POST https://api.devbank.apiture.com/invitations/revoked

Revoke an invitation that is eligible to be revoked. Only Invitations which are sent can be revoked. This operation is invoked from the apiture:revoke link on an invitation, which only exists if the action is allowed. This changes the state to revoked.

This operation has no effect if the invitation is already revoked.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/invitation/v1.2.0/profile.json",
  "sharedSecret": "obsolete obese octopus",
  "type": "joint",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/invitations/invitation/2dce7016-0059-46d0-92fa-aed853b80c10"
    },
    "apiture:acceptInvitationUserExperience": {
      "href": "https://devbank.apiture.com/accceptProductInvitation?invitationId=2dce7016-0059-46d0-92fa-aed853b80c10"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "state": "sent",
  "verificationCount": 0,
  "createdBy": "maxinepeck123",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "expiresAt": "2019-02-20T05:54:52.375Z",
  "customerId": "57212",
  "customerGroup": "2",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}

Responses

sendInvitation

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/invitations/sent?invitation=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/invitations/sent?invitation=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/invitations/sent?invitation=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/sent',
  method: 'post',
  data: '?invitation=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/invitations/sent',
  params: {
  'invitation' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/invitations/sent', params={
  'invitation': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/invitations/sent?invitation=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/invitations/sent", data)
    req.Header = headers

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

Send an Invitation

POST https://api.devbank.apiture.com/invitations/sent

This action will re-send an already sent invitation to the invitee. Only Invitations which are already sent can be re-sent. This operation is invoked from the apiture:send link on an Invitation, which only exists if the action is allowed. There is a configurable limit of times that an invitation can be re-sent.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/invitation/v1.2.0/profile.json",
  "sharedSecret": "obsolete obese octopus",
  "type": "joint",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/invitations/invitation/2dce7016-0059-46d0-92fa-aed853b80c10"
    },
    "apiture:acceptInvitationUserExperience": {
      "href": "https://devbank.apiture.com/accceptProductInvitation?invitationId=2dce7016-0059-46d0-92fa-aed853b80c10"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "state": "sent",
  "verificationCount": 0,
  "createdBy": "maxinepeck123",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "expiresAt": "2019-02-20T05:54:52.375Z",
  "customerId": "57212",
  "customerGroup": "2",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}

Responses

completeInvitation

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/invitations/completed?invitation=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/invitations/completed?invitation=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/invitations/completed?invitation=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/completed',
  method: 'post',
  data: '?invitation=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/invitations/completed',
  params: {
  'invitation' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/invitations/completed', params={
  'invitation': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/invitations/completed?invitation=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/invitations/completed", data)
    req.Header = headers

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

Complete an Invitation

POST https://api.devbank.apiture.com/invitations/completed

Complete an invitation that is eligible to be completed. Only Invitations which are accepted can be completed. This admin operation is invoked from the apiture:complete link on an Invitation, which only exists if the action is allowed. This changes the state to completed. Completed means the desired result (user added as joint owner or authorized signer) has been completed.

This operation has no effect if the invitation is already completed.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/invitation/v1.2.0/profile.json",
  "sharedSecret": "obsolete obese octopus",
  "type": "joint",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/invitations/invitation/2dce7016-0059-46d0-92fa-aed853b80c10"
    },
    "apiture:acceptInvitationUserExperience": {
      "href": "https://devbank.apiture.com/accceptProductInvitation?invitationId=2dce7016-0059-46d0-92fa-aed853b80c10"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "state": "sent",
  "verificationCount": 0,
  "createdBy": "maxinepeck123",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "expiresAt": "2019-02-20T05:54:52.375Z",
  "customerId": "57212",
  "customerGroup": "2",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}

Responses

Verification

Invitation Verifications

verifyInvitation

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/invitations/verifications \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/invitations/verifications HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/invitations/verification/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "sharedSecret": "obsolete obese octopus",
  "invitationId": "d62c0701-0d74-4836-83f9-ebf3709442ea"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/invitations/verifications',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/invitations/verifications',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/invitations/verifications',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/invitations/verifications', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/invitations/verifications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/invitations/verifications", data)
    req.Header = headers

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

Verify an Invitation

POST https://api.devbank.apiture.com/invitations/verifications

Verify (accept) an invitation that is eligible to be verified. Only invitations in a state of sent can be verified. sharedSecret and invitationId are required. This operation increases the verificationCount of the invitation identified by invitationId. Invitations that are revoked or expired are not processed. This operation does not verify invitations with a state of revoked or expired.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/verification/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "sharedSecret": "obsolete obese octopus",
  "invitationId": "d62c0701-0d74-4836-83f9-ebf3709442ea"
}

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/verification/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "sharedSecret": "obsolete obese octopus",
  "invitationId": "d62c0701-0d74-4836-83f9-ebf3709442ea"
}

Responses

Schemas

abstractRequest

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

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.

This schema was resolved from common/abstractRequest.

Properties

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Abstract Resource (v2.1.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.

This schema was resolved from common/abstractResource.

Properties

attributes

{}

Attributes (v2.1.0)

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

This schema was resolved from common/attributes.

Properties

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Collection (v2.1.0)

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

This schema was resolved from common/collection.

Properties

createInvitation

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/createInvitation/v2.2.0/profile.json",
  "_links": {},
  "sharedSecret": "obsolete obese octopus",
  "type": "productPromotion",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}

Create Invitation (v2.2.0)

Representation used to create a new Invitation.

Properties

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.1.0)

Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

Properties

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.1.0)

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

This schema was resolved from common/errorResponse.

Properties

invitation

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/invitation/v1.2.0/profile.json",
  "sharedSecret": "obsolete obese octopus",
  "type": "joint",
  "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
  "inviterFullName": "Maxine Peck",
  "emailAddress": "Max.Peck@nasa.example.com",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/invitations/invitation/2dce7016-0059-46d0-92fa-aed853b80c10"
    },
    "apiture:acceptInvitationUserExperience": {
      "href": "https://devbank.apiture.com/accceptProductInvitation?invitationId=2dce7016-0059-46d0-92fa-aed853b80c10"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "firstName": "Max",
  "lastName": "Peck",
  "identification": "3333",
  "state": "sent",
  "verificationCount": 0,
  "createdBy": "maxinepeck123",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "expiresAt": "2019-02-20T05:54:52.375Z",
  "customerId": "57212",
  "customerGroup": "2",
  "attributes": {
    "applicationAttributes": {
      "productCode": "DD12M_LA",
      "accountAttributes": {
        "refid": "49jfelk3"
      }
    }
  }
}

Invitation (v1.2.0)

Representation of invitation resources.

Links

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

Properties

invitationState

"sent"

Invitation State (v1.0.0)

The state of an invitation.

invitationState strings may have one of the following enumerated values:

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

type: string

enum values: sent, accepted, completed, revoked, expired

invitationType

"joint"

Invitation Type (v1.1.0)

The type of the invitation.

invitationType strings may have one of the following enumerated values:

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

type: string

enum values: joint, authorizedSigner, productPromotion

invitations

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/invitations/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/invitations/invitations?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/invitations/invitations?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/invitations/invitations?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/invitations/invitations"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "invitations",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "firstName": "Max",
        "lastName": "Peck",
        "identification": "3333",
        "sharedSecret": "obsolete obese octopus",
        "emailAddress": "Max.Peck@nasa.example.com",
        "type": "joint",
        "accountUri": "https://api.devbank.apiture.com/accounts/account/7443d485-5faf-46d7-8c09-0d35f3433ed7",
        "inviterFullName": "Maxine Peck",
        "state": "sent",
        "verificationCount": 0,
        "createdBy": "maxinepeck123",
        "createdAt": "2019-01-20T05:54:52.375Z",
        "expiresAt": "2019-02-20T05:54:52.375Z",
        "customerId": "57212",
        "customerGroup": "2",
        "_profile": "https://production.api.apiture.com/schemas/invitations/invitation/v1.2.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/invitations/invitation/2dce7016-0059-46d0-92fa-aed853b80c10"
          }
        }
      }
    ]
  }
}

Invitation Collection (v1.2.0)

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

Properties

labelGroup

{
  "unknown": {
    "label": "Unknown",
    "code": "0",
    "hidden": true
  },
  "under1Million": {
    "label": "Under $1M",
    "code": "1",
    "range": "[0,1000000.00)",
    "variants": {
      "fr": {
        "label": "Moins de $1M"
      }
    }
  },
  "from1to10Million": {
    "label": "$1M to $10M",
    "code": "2",
    "range": "[1000000.00,10000000.00)",
    "variants": {
      "fr": {
        "label": "$1M \\u00e0 $10M"
      }
    }
  },
  "from10to100Million": {
    "label": "$10M to $100M",
    "code": "3",
    "range": "[10000000.00,100000000.00)",
    "variants": {
      "fr": [
        "label $10M \\u00e0 $100M"
      ]
    }
  },
  "over100Million": {
    "label": "Over $100,000,000.00",
    "code": "4",
    "range": "[100000000.00,]",
    "variants": {
      "fr": {
        "label": "Plus de $10M"
      }
    }
  },
  "other": {
    "label": "Other",
    "code": 254
  }
}

Label Group (v1.0.0)

A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00).

This allows the client to let the user select a value from a list, such as the following derived from the labels in the example:

• Unknown
• Under $1M
• $1M to $10M
• $10M to $100M
• $100M or more

Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }.

This schema was resolved from common/labelGroup.

Properties

labelGroups

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "fristGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Label Groups (v1.1.0)

A set of named groups of labels, each of which contains multiple item labels.

The abbreviated example shows two groups, one named structure and one named estimatedAnnualRevenue. The first has items with names such as corporation, llc and soleProprietorship, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million has the label "$1M to $10M" and the range [1000000.00,10000000.00).

This schema was resolved from common/labelGroups.

Properties

labelItem

{
  "over100Million": {
    "label": "Over $100,000,000.00",
    "code": "4",
    "range": "[100000000.00,]",
    "variants": {
      "fr": {
        "label": "Plus de $10M"
      }
    }
  }
}

Label Item (v1.0.0)

An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each (simpleLabel) variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external syststems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI.

This schema was resolved from common/labelItem.

Properties

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.

This schema was resolved from common/link.

Properties

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.

This schema was resolved from common/links.

Properties

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

API Root (v2.1.0)

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

This schema was resolved from common/root.

Properties

simpleLabel

{
  "label": "Board of Directors",
  "description": "string"
}

Simple Label (v1.0.0)

A text label and optional description.

This schema was resolved from common/simpleLabel.

Properties

verification

{
  "_profile": "https://production.api.apiture.com/schemas/invitations/verification/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "sharedSecret": "obsolete obese octopus",
  "invitationId": "d62c0701-0d74-4836-83f9-ebf3709442ea"
}

Verification (v2.1.0)

The request and response for verifying an invitation.

Properties