Text v0.2.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.

Manage localizable and customizable text strings for client applications.

The Text API is a repository for customizable and localizable text strings which the financial institution may wish to customize in order to change their user experience. The primary consumer of this API is client applications.

Example of customizable text includes:

• page or form titles
• field labels
• hover tips
• URLs (for images or other resources)
• icon references in image icon sets
• instructions or other in-line help
• larger text blocks such as Markdown text blocks.

The Text API manages only static text that is part of the UX or clients, not dynamic changing text data (such as an banking product names, document names, description) provided by the services or the users.

Text is organized into named groups of related strings. These groups often correspond to client application features, such as banking, transfers, or digital account opening. The special group name common represents content that is "common" to (or shared with) all other groups. Groups names may be nested logically. For example, the group common.fi is for text related to the financial institution within the common group.

Text strings may include references to other strings. For example consider the message string

Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.supportLink}}

This template resolve to a string result such as

Contact 3rd Party Bank customer support at 555-555-1234 or [Support](https://www3rdparty.bank/support)

{{common.fi.supportNumber}} is an example of a string reference by a key which consists of a group name (common.fi) and string name (supportNumber). Unresolved references are left unexpanded. For example, if there is no string named supportUrl in the common.fi group, the above text string request returns

Contact 3rd Party Bank customer support at 555-555-1234 or {{common.fi.supportLink}}

By convention, string references without group names (that is, those with the format {{name}}) are not expanded by the Text service and are left for client-side expansion using a client-supplied environment map of name/value pairs. The same is true for references {{groupId.textStringId}} where the named group or string are not defined.)

Text strings are referenced by a string ID, which must be a simple name:

name = [ letter | "_" ] ( letter | digit | "_" | "$" )*
textStringId = name

A group ID is a simple name or .-separated names for two- or three-level names such as level1.level2.level3.

groupId = name ( "." name ) {0,2}

The concatenation of the group ID and a period and the string ID is the string's key.

The Text API supports customizing the text for different client languages. When retrieving text for a specific language, the service will follow language inheritance rules. For example, when asking for strings for es-MX, if a string is not defined for es-MX, the service will look for a value for es and if not set, will return the value defined for the default language (en-US). The default language-independent value for a string ID must be defined.

Text also supports content that is specific to a format which represents different user experience form factors. A mobile app with a smaller screen format may require a different set of labels than those used for web or larger tablets. The service will also fall back from format-specific to format-agnostic labels.

The language and format are examples of optional text parameters.

The client can request text either by the URL path GET /groups/{groupId}/strings/{textStringId} or by requesting all text strings in one or more groups via GET /text/resolved?group=group1|group2|...|groupN or for all groups, GET /text/resolved. These operations support parameterization of the response with the format= query parameter and/or the ?languages= query parameter. Note that unlike many other Apiture APIs, the identifiers for groups and strings (groupId and textStringId) are names, not opaque resource IDs. Clients may use PUT to create or update new groups and new text strings within groups with client-supplied names rather than using POST to create resources and have the service generate the IDs.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. Each client 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.apiture.com/oauth2/authorize
  • Token URL = http://auth.apiture.com/auth/oauth2/token

Text

Text

getResolvedText

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/resolved \
  -H 'Accept: application/hal+json' \
  -H 'Accept-Language: string' \
  -H 'If-None-Match: string'

GET https://api.devbank.apiture.com/text/resolved HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
Accept-Language: string
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'Accept-Language':'string',
  'If-None-Match':'string'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/resolved',
  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',
  'If-None-Match':'string'

};

fetch('https://api.devbank.apiture.com/text/resolved',
{
  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',
  'If-None-Match' => 'string'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'Accept-Language': 'string',
  'If-None-Match': 'string'
}

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/resolved");
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"},
        "If-None-Match": []string{"string"},
        
    }

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

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

GET /resolved

Return all text groups and text strings for the specified (or default) language and the specified (or default) client format. The strings are resolved by replacing string references (references have the form {{key}}) to other text strings with their corresponding values.

This operation is the primary operation that clients use to load the text strings to present to one end user, based on that user's preferred language and their device format.

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/text/resolvedStrings/v1.0.0/profile.json",
  "format": "large",
  "languages": [
    "en-US",
    "en"
  ],
  "groups": {
    "common": {
      "greeting": "Welcome, {{user.preferredName}}"
    },
    "common.fi": {
      "name": "3rd Party Bank",
      "supportNumber": "555-555-1234",
      "supportUrl": "https://www3rdparty.bank/support",
      "supportLink": "[Support](https://www3rdparty.bank/support)",
      "support": "Contact 3rd Party Bank customer support at 555-555-1234 or https://www3rdparty.bank/support",
      "help": "For more help, please visit [Our help page]({{common.fi.helpUrl}})"
    },
    "checkDeposit": {
      "title": "Remote Check Deposit",
      "scanFront": "Take an image of the front of the check",
      "scanBack": "Take an image of the back of the check"
    }
  },
  "unresolvedKeys": [
    "common.fi.helpUrl",
    "user.preferredName"
  ]
}

Responses

Response Headers

Text String

Text String

getStrings

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/groups/{groupId}/strings \
  -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/text/groups/{groupId}/strings HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}/strings',
  method: 'get',

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

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

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

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}/strings',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/groups/{groupId}/strings',
  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/text/groups/{groupId}/strings', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}/strings");
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/text/groups/{groupId}/strings", data)
    req.Header = headers

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

Return a collection of text strings

GET /groups/{groupId}/strings

Return a collection of text strings within the group. Since the number of text strings in a group is relatively small, this operation does not implement pagination, sorting, filtering, or searching.

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/text/textStrings/v1.0.0/profile.json",
  "name": "strings",
  "start": 0,
  "limit": 2,
  "count": 2,
  "_links": {
    "self": {
      "href": "/text/groups/common.fi/strings"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "supportNumber",
        "values": [
          {
            "value": "(910) 999-9999",
            "format": "small"
          }
        ],
        "_profile": "https://api.apiture.com/schemas/text/textString/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi/strings/supportNumber"
          }
        }
      },
      {
        "name": "supportUrl",
        "values": [
          {
            "value": "https://www.3rdparty.bank/support",
            "format": "small"
          },
          {
            "value": "https://www.3rdparty.bank/es/support",
            "language": "es",
            "format": "small"
          },
          {
            "value": "https://www.3rdparty.bank/fr/support",
            "language": "fr",
            "format": "small"
          }
        ],
        "_profile": "https://api.apiture.com/schemas/text/textString/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi/strings/supportUrl"
          }
        }
      }
    ]
  }
}

Responses

Response Headers

getString

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} \
  -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/text/groups/{groupId}/strings/{textStringId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  method: 'get',

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

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

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

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  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/text/groups/{groupId}/strings/{textStringId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}");
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/text/groups/{groupId}/strings/{textStringId}", data)
    req.Header = headers

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

Fetch a representation of this text string

GET /groups/{groupId}/strings/{textStringId}

Return a HAL representation of this text string resource.

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/text/textString/v1.0.0/profile.json",
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.supportUrl}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.supportUrl}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.supportUrl}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.supportUrl}}",
      "format": "small",
      "language": "fr"
    }
  ]
}

Responses

Response Headers

setString

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  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/text/textString/v1.0.0/profile.json",
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.supportUrl}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.supportUrl}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.supportUrl}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.supportUrl}}",
      "format": "small",
      "language": "fr"
    }
  ]
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}", data)
    req.Header = headers

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

Create or update a text string

PUT /groups/{groupId}/strings/{textStringId}

Create a new text with the textStringId name, if one did not already exist, or update the properties of this text string, This operation is limited to administrative use.

Body parameter

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/text/textString/v1.0.0/profile.json",
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.supportUrl}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.supportUrl}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.supportUrl}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.supportUrl}}",
      "format": "small",
      "language": "fr"
    }
  ]
}

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/text/textString/v1.0.0/profile.json",
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.supportUrl}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.supportUrl}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.supportUrl}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.supportUrl}}",
      "format": "small",
      "language": "fr"
    }
  ]
}

Responses

Response Headers

deleteString

Code samples

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

DELETE https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId} HTTP/1.1
Host: api.devbank.apiture.com

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  method: 'delete',

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

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

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

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}',
  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/text/groups/{groupId}/strings/{textStringId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}/strings/{textStringId}");
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/text/groups/{groupId}/strings/{textStringId}", data)
    req.Header = headers

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

Delete this text string resource

DELETE /groups/{groupId}/strings/{textStringId}

Delete this text string resource and any resources that are owned by it. This operation is limited to administrative use.

Parameters

    
      Click on 'Try It' to get a response.
    
  

Responses

Text Group

Group of Text Strings

getGroups

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/groups \
  -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/text/groups HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/groups',
  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/text/groups', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "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/text/groups", data)
    req.Header = headers

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

Return a collection of text groups

GET /groups

Return the collection of text groups. Since the number of groups is relatively small, this operation does not implement pagination, sorting, filtering, or searching.

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/text/groups/v1.0.0/profile.json",
  "name": "groups",
  "start": 0,
  "limit": 32,
  "count": 32,
  "_links": {
    "self": {
      "href": "/text/groups"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "common.fi",
        "label": "Common financial institution text",
        "description": "General text which pertains to the financial institution.",
        "immutable": false,
        "modifiedAt": "2019-11-18T11:23:16.375Z",
        "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi"
          }
        }
      },
      {
        "name": "help",
        "label": "Help text",
        "description": "Strings that represents in-application help text, such as tool tips.",
        "immutable": false,
        "modifiedAt": "2019-11-20T12:36:02.375Z",
        "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/help"
          }
        }
      }
    ]
  }
}

Responses

Response Headers

getGroup

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/groups/{groupId} \
  -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/text/groups/{groupId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}',
  method: 'get',

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

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

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

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/groups/{groupId}',
  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/text/groups/{groupId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}");
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/text/groups/{groupId}", data)
    req.Header = headers

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

Fetch a representation of this text group

GET /groups/{groupId}

Return a HAL representation of this text group resource.

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
  "name": "common.fi",
  "label": "Common financial institution text",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  }
}

Responses

Response Headers

setGroup

Code samples

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

PUT https://api.devbank.apiture.com/text/groups/{groupId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
  "name": "common.fi",
  "label": "Common financial institution text",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api.devbank.apiture.com/text/groups/{groupId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.devbank.apiture.com/text/groups/{groupId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Create or update a text group

PUT /groups/{groupId}

Create a text group, or update an existing text group's properties.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
  "name": "common.fi",
  "label": "Common financial institution text",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  }
}

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
  "name": "common.fi",
  "label": "Common financial institution text",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  }
}

Responses

Response Headers

deleteGroup

Code samples

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

DELETE https://api.devbank.apiture.com/text/groups/{groupId} HTTP/1.1
Host: api.devbank.apiture.com

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/groups/{groupId}',
  method: 'delete',

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

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

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

};

fetch('https://api.devbank.apiture.com/text/groups/{groupId}',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.devbank.apiture.com/text/groups/{groupId}',
  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/text/groups/{groupId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/groups/{groupId}");
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/text/groups/{groupId}", data)
    req.Header = headers

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

Delete this text group resource

DELETE /groups/{groupId}

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

Parameters

    
      Click on 'Try It' to get a response.
    
  

Responses

API

The Text API

getApi

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/',
  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/text/', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/");
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/text/", 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.

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "http://localhost:8080/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

Responses

getApiDoc

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/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/text/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/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/text/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.

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{}

Responses

Response Schema

Text Format

getFormats

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/formats \
  -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/text/formats HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/formats',
  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/text/formats', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/formats");
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/text/formats", data)
    req.Header = headers

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

Return a collection of text formats

GET /formats

Return a collection of text formats.

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/text/formats/v1.0.0/profile.json",
  "name": "formats",
  "start": 0,
  "limit": 2,
  "count": 2,
  "_links": {
    "self": {
      "href": "/text/formats"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "small",
        "description": "Small or limited screen real estate, such as a hand held smartphone.",
        "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/formats/small"
          }
        }
      },
      {
        "name": "large",
        "description": "A large format device with generous screen real estate, such as a desktop or laptop application or browser.",
        "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/formats/large"
          }
        }
      }
    ]
  }
}

Responses

Response Headers

getFormat

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/text/formats/{formatId} \
  -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/text/formats/{formatId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/formats/{formatId}',
  method: 'get',

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

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

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

};

fetch('https://api.devbank.apiture.com/text/formats/{formatId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/text/formats/{formatId}',
  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/text/formats/{formatId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/text/formats/{formatId}");
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/text/formats/{formatId}", data)
    req.Header = headers

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

Fetch a representation of this text format

GET /formats/{formatId}

Return a HAL representation of this text format resource.

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone.",
  "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json"
}

Responses

Response Headers

setFormat

Code samples

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

PUT https://api.devbank.apiture.com/text/formats/{formatId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/text/formats/{formatId}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone.",
  "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api.devbank.apiture.com/text/formats/{formatId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.devbank.apiture.com/text/formats/{formatId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Update or create a text format

PUT /formats/{formatId}

Perform a complete replacement of this text format.

Body parameter

{
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone.",
  "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json"
}

Parameters

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone.",
  "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json"
}

Responses

Response Headers

Schemas

textStringItem

{
  "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.supportUrl}}",
  "format": "large",
  "language": "fr"
}

Text String Item (Version v1.0.0)

A since string value, corresponding to a textStringId, language code, and a format code. One or more text string items form a textString object with a shared textStringId.

Properties

textString

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/text/textString/v1.0.0/profile.json",
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "values": [
    {
      "value": "Contact {{common.fi.name}} customer support at {{common.fi.supportNumber}} or {{common.fi.supportUrl}}",
      "format": "large"
    },
    {
      "value": "Contact {{common.fi.name}} support at {{common.fi.supportUrl}}",
      "format": "small"
    },
    {
      "value": "Póngase en contacto con el servicio de atención al cliente de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "large",
      "language": "es"
    },
    {
      "value": "Póngase en contacto con el soporte de {{common.fi.name}} en {{common.fi.supportNumber}} o {{common.fi.supportUrl}}",
      "format": "small",
      "language": "es"
    },
    {
      "value": "Contactez le support client {{common.fi.name}} au {{common.fi.supportNumber}} ou au {{common.fi.supportUrl}}",
      "format": "large",
      "language": "fr"
    },
    {
      "value": "Contacter le support {{common.fi.name}} au {{common.fi.supportUrl}}",
      "format": "small",
      "language": "fr"
    }
  ]
}

Text String (Version v1.0.0)

Representation of text string resources named by a textStringId within a group. Each string contains one or more values, parameterized by an optional language code and format code.

Properties

Links

Representations using this textString schema may contain the following links:

resolvedStrings

{
  "_profile": "https://api.apiture.com/schemas/text/resolvedStrings/v1.0.0/profile.json",
  "format": "large",
  "languages": [
    "en-US",
    "en"
  ],
  "groups": {
    "common": {
      "greeting": "Welcome, {{user.preferredName}}"
    },
    "common.fi": {
      "name": "3rd Party Bank",
      "supportNumber": "555-555-1234",
      "supportUrl": "https://www3rdparty.bank/support",
      "supportLink": "[Support](https://www3rdparty.bank/support)",
      "support": "Contact 3rd Party Bank customer support at 555-555-1234 or https://www3rdparty.bank/support",
      "help": "For more help, please visit [Our help page]({{common.fi.helpUrl}})"
    },
    "checkDeposit": {
      "title": "Remote Check Deposit",
      "scanFront": "Take an image of the front of the check",
      "scanBack": "Take an image of the back of the check"
    }
  },
  "unresolvedKeys": [
    "common.fi.helpUrl",
    "user.preferredName"
  ]
}

Resolved Strings (Version v1.0.0)

Resolved text string items for a specific language or set of languages and format. This contains groups which is a map of maps. The outer map has group names as keys and inner maps as values; the inner maps have text string names as keys and raw string values as the values. These are very light-weight representations if groups and text strings.

Properties

resolvedGroup

{
  "name": "3rd Party Bank",
  "supportNumber": "555-555-1234",
  "supportUrl": "https://www3rdparty.bank/support",
  "supportLink": "[Support](https://www3rdparty.bank/support)",
  "support": "Contact 3rd Party Bank customer support at 555-555-1234 or https://www3rdparty.bank/support",
  "help": "For more help, please visit [Our help page]({{common.fi.helpUrl}})"
}

Resolved Group (Version v1.0.0)

A resolved group of text string values for a specific language or set of languages and format. The keys in this object are group IDs such as common, common.fi, or checkDeposit. The values map string IDs to simple strings objects, with any resolvable text string references replaced by their values. In the example below, there is no text string user.preferredName so it is left unresolved.

Properties

textStrings

{
  "_profile": "https://api.apiture.com/schemas/text/textStrings/v1.0.0/profile.json",
  "name": "strings",
  "start": 0,
  "limit": 2,
  "count": 2,
  "_links": {
    "self": {
      "href": "/text/groups/common.fi/strings"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "supportNumber",
        "values": [
          {
            "value": "(910) 999-9999",
            "format": "small"
          }
        ],
        "_profile": "https://api.apiture.com/schemas/text/textString/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi/strings/supportNumber"
          }
        }
      },
      {
        "name": "supportUrl",
        "values": [
          {
            "value": "https://www.3rdparty.bank/support",
            "format": "small"
          },
          {
            "value": "https://www.3rdparty.bank/es/support",
            "language": "es",
            "format": "small"
          },
          {
            "value": "https://www.3rdparty.bank/fr/support",
            "language": "fr",
            "format": "small"
          }
        ],
        "_profile": "https://api.apiture.com/schemas/text/textString/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi/strings/supportUrl"
          }
        }
      }
    ]
  }
}

Text String Collection (Version v1.0.0)

Collection of text strings. The items in the collection are ordered in the _embedded.items array; the name is strings.

Properties

group

{
  "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
  "name": "common.fi",
  "label": "Common financial institution text",
  "description": "General text which pertains to the financial institution.",
  "immutable": false,
  "modifiedAt": "2019-11-18T11:23:16.375Z",
  "_links": {
    "self": {
      "href": "/text/groups/common.fi"
    }
  }
}

Text Group (Version v1.0.0)

A text group is a named set of related text strings.

Properties

Links

Representations using this group schema may contain the following links:

groups

{
  "_profile": "https://api.apiture.com/schemas/text/groups/v1.0.0/profile.json",
  "name": "groups",
  "start": 0,
  "limit": 32,
  "count": 32,
  "_links": {
    "self": {
      "href": "/text/groups"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "common.fi",
        "label": "Common financial institution text",
        "description": "General text which pertains to the financial institution.",
        "immutable": false,
        "modifiedAt": "2019-11-18T11:23:16.375Z",
        "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/common.fi"
          }
        }
      },
      {
        "name": "help",
        "label": "Help text",
        "description": "Strings that represents in-application help text, such as tool tips.",
        "immutable": false,
        "modifiedAt": "2019-11-20T12:36:02.375Z",
        "_profile": "https://api.apiture.com/schemas/text/group/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/groups/help"
          }
        }
      }
    ]
  }
}

Text Group Collection (Version v1.0.0)

Collection of text groups. The items in the collection are ordered in the _embedded.items array; the name is groups.

Properties

format

{
  "name": "small",
  "description": "Small or limited screen real estate, such as a hand held smartphone.",
  "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json"
}

Text Format (Version v1.0.0)

Representation of text format resources. Text formats represent client-side presentation formats, such as small for a display with limited screen real estate, or large for a display with generous screen real estate. The text service supports small and large, and small is the default format.

Properties

formats

{
  "_profile": "https://api.apiture.com/schemas/text/formats/v1.0.0/profile.json",
  "name": "formats",
  "start": 0,
  "limit": 2,
  "count": 2,
  "_links": {
    "self": {
      "href": "/text/formats"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "small",
        "description": "Small or limited screen real estate, such as a hand held smartphone.",
        "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/formats/small"
          }
        }
      },
      {
        "name": "large",
        "description": "A large format device with generous screen real estate, such as a desktop or laptop application or browser.",
        "_profile": "https://api.apiture.com/schemas/text/format/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/text/formats/large"
          }
        }
      }
    ]
  }
}

Text Format Collection (Version v1.0.0)

Collection of text formats. The items in the collection are ordered in the _embedded.items array; the name is formats. This collection is small and thus does not support pagination links.

Properties

errorResponse

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

Error Response (Version vv2.0.0)

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

Properties

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "http://localhost:8080/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

API Root (Version vv2.0.0)

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

Properties

links

{
  "property1": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  },
  "property2": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  }
}

Links (Version vv1.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

error

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

Error (Version vv1.0.0)

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

Properties

link

{
  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Applicant"
}

Link (Version vv1.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

attributes

{}

Attributes (Version vv1.0.0)

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

Properties