Banking Admin Customer Audiences v0.5.0

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

An audience is a subset of banking customers (members) as selected by some filter criteria. Audiences (sometimes called a customer segmentation) may be used to define a target set of customers for a marketing or communication campaign, or to define analytics related to the customers in that subset. Audiences are defined and managed by financial institution administrators and analysts. Each analyst can list and view all audiences they have created and those which others have shared with them. Analysts can create or copy audiences. Audiences can be shared with other analysts who are collaborators.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/bankingAdmin

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based client identification. See details at Secure Access.

• OpenID Connect authentication (accessToken)
  • OpenId Connect (OIDC) authentication/authorization. The client uses the authorization_endpoint and token_endpoint to obtain an access token to pass in the Authorization header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access.
  • OIDC Configuration URL = https://auth.apiture.com/oidc/.well-known/openid-configuration

Customer Audiences

Banking Customer Audiences

listCustomerAudienceCustomerIds

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch a page of the customer audience IDs

GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds

Return a page of customer audience IDs for this audience. This is the resource IDs of banking customers who satisfy the filter criteria defined by this customer audience. There can be many thousands or even millions of customers, so the client must fetch these via pagination with a maximum limit of 100,000 customers per page. The customer audience resource indicates how many customers satisfy the audience filter criteria.

Parameters

Parameter	Description
start in: query	string The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url. default: "" maxLength: 256 pattern: ^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$
limit in: query	integer(int32) The maximum number of items to return in this paged response. format: int32 default: 10000 minimum: 0 maximum: 100000
customerAudienceId in: path	resourceId (required) The unique identifier of this customer audience. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

Example responses

200 Response

{
  "count": 189,
  "items": [
    "9dfb049f5672424d7b3b",
    "f26c043c527f42430b15",
    "40ce35bd15417a2e2a09",
    "c84fd4b81049c27d4a65",
    "b8e93bb1bd22dba4093c",
    "c5247e8f5de1a4e79f67",
    "5e979274f87e41eee739",
    "6dc7c36cb2306288919f",
    "09c8fdf03607d0e12c91",
    "c50aae5d1be0ad19ca5b"
  ],
  "nextPage_url": "https://production.api.apiture.com/bankingAdmin/customerAudiences/customerIds?start=74f96e77c3aafcb9fe85?limit=10"
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listCustomerAudiences

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/customerAudiences \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/customerAudiences HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

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

}, headers = headers)

print r.json()

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

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

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

Return a collection of customer audiences

GET https://api.apiture.com/bankingAdmin/customerAudiences

Return a collection of customer audiences for the current analyst. This includes audiences the analyst has created and audiences that others have shared with them.

Example responses

200 Response

{
  "items": [
    {
      "name": "New Customers Ages 35-49",
      "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
      "customerType": "retail",
      "customerCount": 12340,
      "totalCustomerCount": 2340659,
      "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
      "id": "0399abedfd3d",
      "state": "active",
      "createdAt": "2023-04-14T06:47:53.375Z",
      "updatedAt": "2023-04-24T08:48:05.000Z",
      "source": "list",
      "allows": {
        "edit": false,
        "share": false,
        "manageCollaborators": false,
        "manageFilters": false,
        "copy": true,
        "archive": false,
        "restore": false
      },
      "ownedBy": {
        "id": "0399abedfd3d",
        "firstName": "Bob",
        "lastName": "Hartley",
        "username": "bhartley"
      },
      "updatedBy": {
        "id": "0399abedfd3d",
        "firstName": "Bob",
        "lastName": "Hartley",
        "username": "bhartley"
      },
      "collaborators": [
        {
          "id": "0399abedfd3d",
          "firstName": "Bob",
          "lastName": "Hartley",
          "username": "bhartley"
        },
        {
          "id": "389a2238d9f5c275d172",
          "firstName": "Carol",
          "lastName": "Wallace",
          "username": "cwallace"
        },
        {
          "id": "69fdb75ba971f3291432",
          "firstName": "Jerry",
          "lastName": "Robinson",
          "username": "jrobinson"
        }
      ]
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

createCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/customerAudiences \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/customerAudiences HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAudiences");
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/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Create a new customer audience

POST https://api.apiture.com/bankingAdmin/customerAudiences

Create a new customer audience within the customer audiences collection.

Body parameter

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail"
}

Parameters

Parameter	Description
copyOf in: query	resourceId Copy the properties and filters of the referenced audience resource, except the collaborators. The copyOf parameter is the resource id of the source audience resource. Values in the request body override the values from the source. insightId and copyOf are mutually exclusive. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
insightId in: query	resourceId Create an audience from the referenced audience insight resource. This value is the id of the insight instance. Other attributes of the resulting audience (the customerType, filters) are immutable in the new customerType audience. insightId and copyOf are mutually exclusive. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
body	newCustomerAudience (required) The data necessary to create a new customer audience.

Example responses

201 Response

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": false,
    "share": false,
    "manageCollaborators": false,
    "manageFilters": false,
    "copy": true,
    "archive": false,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getCustomerAudience

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch a representation of this customer audience

GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}

Return the JSON representation of this customer audience resource.

Parameters

Parameter	Description
customerAudienceId in: path	resourceId (required) The unique identifier of this customer audience. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

Example responses

200 Response

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": false,
    "share": false,
    "manageCollaborators": false,
    "manageFilters": false,
    "copy": true,
    "archive": false,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchCustomerAudience

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId} \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail"
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}',
  method: 'patch',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/merge-patch+json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/merge-patch+json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/merge-patch+json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}", data)
    req.Header = headers

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

Update this customer audience

PATCH https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}

Perform a partial update of this customer audience as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated.

Body parameter

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail"
}

Parameters

Parameter	Description
body	customerAudiencePatch (required) The fields to update within the customer audience.
customerAudienceId in: path	resourceId (required) The unique identifier of this customer audience. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

Example responses

200 Response

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": false,
    "share": false,
    "manageCollaborators": false,
    "manageFilters": false,
    "copy": true,
    "archive": false,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Customer Audience Actions

Actions on a Banking Customer Audience

archiveCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/archived \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/archived HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/archived',
{
  method: 'POST',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/archived',
  method: 'post',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/archived',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/archived', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/archived");
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/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Archive a customer audience

POST https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/archived

Archive a customer audience. This changes the state property of the customer audience to archived. The response is the updated representation of the customer audience. This operation is idempotent: no changes are made if the customer audience is already archived. Archived audiences are automatically removed 30 days after being archived.

Audiences that are in use elsewhere may not be archived.

Parameters

Parameter	Description
customerAudienceId in: path	resourceId (required) The unique identifier of this customer audience. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

Example responses

200 Response

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": false,
    "share": false,
    "manageCollaborators": false,
    "manageFilters": false,
    "copy": true,
    "archive": false,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

restoreCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/active \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/active HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/active',
{
  method: 'POST',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/active',
  method: 'post',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/active',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/active', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/active");
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/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Restore an archived customer audience.

POST https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/active

Restore an archived customer audience. This changes the state property of the customer audience from archived to active. The response is the updated representation of the customer audience. This operation is idempotent: no changes are made if the customer audience is already active.

Parameters

Parameter	Description
customerAudienceId in: path	resourceId (required) The unique identifier of this customer audience. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

Example responses

200 Response

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": false,
    "share": false,
    "manageCollaborators": false,
    "manageFilters": false,
    "copy": true,
    "archive": false,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

importCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/importedCustomerAudiences \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/importedCustomerAudiences HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/importedCustomerAudiences");
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/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Import a customer audience

POST https://api.apiture.com/bankingAdmin/importedCustomerAudiences

Create a new customer audience from a file containing a list of customer identifiers. The import operation supports comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx format) files with an optional header row. The file must consist of only one column of customer IDs. Files with additional columns result in import failures. The customers for the created audience may only be updated with updateCustomerAudienceCustomerIds.

Body parameter

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}

Parameters

Parameter	Description
body	customerAudienceImport

Example responses

201 Response

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": true,
    "share": true,
    "manageCollaborators": true,
    "manageFilters": false,
    "copy": true,
    "archive": true,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "unmatchedCount": 2,
  "unmatchedIds": [
    "c50aae5d1be0ad19ca5b",
    "f26c0-43c527f42430b15"
  ],
  "fileName": "2023_18to35_north_carolina.csv"
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

validateCustomerAudience

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/validatedCustomerAudiences \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/validatedCustomerAudiences HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/validatedCustomerAudiences");
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/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Validate a file of customer identifiers

POST https://api.apiture.com/bankingAdmin/validatedCustomerAudiences

Validate a file containing a list of customer identifiers. The operation supports comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx format) files with an optional header row. The file must consist of only one column of customer IDs. Files with additional columns result in validation failures.

Body parameter

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}

Parameters

Parameter	Description
body	customerAudienceImport

Example responses

200 Response

{
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "unmatchedCount": 0,
  "unmatchedIds": []
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

countAudienceCustomers

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/customerAudienceCounts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/customerAudienceCounts HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ]
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ]
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ]
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ]
        }
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAudienceCounts");
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/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Count the customers who match a set of customer audience filters.

POST https://api.apiture.com/bankingAdmin/customerAudienceCounts

Return a count of the customers who match a set of customer audience filters and the total number of customers at the financial institution.

Body parameter

{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ]
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ]
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ]
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ]
        }
      ]
    }
  ]
}

Parameters

Parameter	Description
body	customerAudienceFilters (required) The filters to use when counting customer who match.

Example responses

200 Response

{
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

updateCustomerAudienceCustomerIds

Code samples

# You can also use wget
curl -X PUT https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "fileName": "2023_18to35_north_carolina.csv"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds',
  method: 'put',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds");
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/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds", data)
    req.Header = headers

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

Update audience customer IDs

PUT https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/customerIds

Replace the list of customer IDs for this audience. This operation supports the same file content formats listed in importCustomerAudience. The customers for this audience may only be replaced if the audience was created with importCustomerAudience (that is, it has a source of list).

Body parameter

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "fileName": "2023_18to35_north_carolina.csv"
}

Parameters

Parameter	Description
body	customerAudienceCustomerIdsImport
customerAudienceId in: path	resourceId (required) The unique identifier of this customer audience. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

Example responses

200 Response

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": true,
    "share": true,
    "manageCollaborators": true,
    "manageFilters": false,
    "copy": true,
    "archive": true,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "unmatchedCount": 2,
  "unmatchedIds": [
    "c50aae5d1be0ad19ca5b",
    "f26c0-43c527f42430b15"
  ],
  "fileName": "2023_18to35_north_carolina.csv"
}

Responses

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 422

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Customer Audience Collaborators

Collaborators on a Banking Customer Audience

listCustomerAudienceCollaborators

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch the list of audience collaborators

GET https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators

Fetch the list of collaborators for a customer audience.

Parameters

Parameter	Description
customerAudienceId in: path	resourceId (required) The unique identifier of this customer audience. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

Example responses

200 Response

{}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchCustomerAudienceCollaborators

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'If-Match: string' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "items": [
    {
      "id": "0399abedfd3d"
    },
    {
      "id": "969461d0b4c74577a8db"
    },
    {
      "id": "00c18c57fbfe92a38ed3"
    },
    {
      "id": "7b66f63c979b908e9e37"
    },
    {
      "id": "4cb851e85606f4e44c53"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'If-Match':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators',
  method: 'patch',

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

require 'rest-client'
require 'json'

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

result = RestClient.patch 'https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.patch('https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators", data)
    req.Header = headers

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

Update the list of collaborators

PATCH https://api.apiture.com/bankingAdmin/customerAudiences/{customerAudienceId}/collaborators

Update the list of collaborators within the customer audience collaborators collection. This replaces the list of collaborators with the new list. The items in this list are analysts from the list of data analysts at the financial institution. The response is not the list of collaborators but the entire customer audience (which reflects the updatedAt and updatedBy properties). If the items array is empty, the audience become unshared; it no longer shows up in other analysts lists of audiences. The owner is not in the list of collaborators, and thus cannot be unshared.

Body parameter

{
  "items": [
    {
      "id": "0399abedfd3d"
    },
    {
      "id": "969461d0b4c74577a8db"
    },
    {
      "id": "00c18c57fbfe92a38ed3"
    },
    {
      "id": "7b66f63c979b908e9e37"
    },
    {
      "id": "4cb851e85606f4e44c53"
    }
  ]
}

Parameters

Parameter	Description
If-Match in: header	string (required) The entity tag that was returned in the ETag response header of a previous call. When this header is not included in the request, the operation fails with a 428 Precondition Required error. The passed entity tag must match the current entity tag of the resource. If the tags do not match, the operation fails with a 412 Precondition Failed error. maxLength: 512 pattern: ^\P{Cc}{1,512}$
body	customerAudienceCollaboratorsPatch (required) The new list of collaborators for a customer audience.
customerAudienceId in: path	resourceId (required) The unique identifier of this customer audience. This is an opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

Example responses

200 Response

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": false,
    "share": false,
    "manageCollaborators": false,
    "manageFilters": false,
    "copy": true,
    "archive": false,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 412

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Data Analysts

People Who Perform Data Analysis at the Financial Institution

listDataAnalysts

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/dataAnalysts \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/dataAnalysts HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/dataAnalysts',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

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

}, headers = headers)

print r.json()

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

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

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

Fetch the list of data analysts

GET https://api.apiture.com/bankingAdmin/dataAnalysts

Fetch the list of people who perform data analysis at the financial institution.

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Schemas

analyticFilterOperatorType

"equals"

Analytic Filter Operator Type (v1.0.0)

Indicates the type of the comparison operator used by an analytic filter.

analyticFilterOperatorType strings may have one of the following enumerated values:

Value	Description
equals	Equals: The measure is equal to a value. A filter using this operator requires exactly 1 value.
notEquals	Not Equals: The measure not equal to a value. A filter using this operator requires exactly 1 value.
lessThan	Less Than: The measurement less than a value. A filter using this operator requires exactly 1 value.
lessThanOrEqualTo	Less Than or Equal To: The measure less than or equal a value. A filter using this operator requires exactly 1 value.
greaterThan	Greater Than: The measure is greater than a value. A filter using this operator requires exactly 1 value.
greaterThanOrEqualTo	Greater Than or Equal To: The measure greater than or equal to a value. A filter using this operator requires exactly 1 value.
between	Between: The measure is Between a minimum and maximum value. A filter using this operator requires exactly 2 values.
notBetween	Not Between: Measure not between a minimum and maximum value. A filter using this operator requires exactly 2 values.
before	Before: Date measure before or on a value. A filter using this operator requires exactly 1 value.
after	After: Date measure on or after a value. A filter using this operator requires exactly 1 value.
in	In: The measure is in a set of values. A filter using this operator requires at least 2 values.
notIn	Not In: The measure is not in a set of values. A filter using this operator requires exactly 2 values.

type: string

enum values: equals, notEquals, lessThan, lessThanOrEqualTo, greaterThan, greaterThanOrEqualTo, before, after, between, notBetween, in, notIn

analyticFilterTypeName

"string"

Analytic Filter Type Name (v1.0.0)

The name of an analytic filter type.

type: string

minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

analyticFilterTypeReference

{
  "id": "3752cfec9b06fae15c9e",
  "name": "customerAge"
}

Analytic Filter Type Reference (v1.0.0)

An object that reference and Analytic Filter Type by its id and name.

Properties

Name	Description
Analytic Filter Type Reference (v1.0.0)	object An object that reference and Analytic Filter Type by its id and name.
id	resourceId (required) The unique identifier for this analytic filter type resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
name	analyticFilterTypeName The name of the filter type. This is for informational purposes only. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

analyticFilterValue

"25-to-49"

Analytic Filter Value (v1.0.0)

A constant value used in a filter, such as 25 in a filter { customerAge greater than 25 }. This value is compared to the measure defined by the filter.

type: string(text)

format: text
maxLength: 200

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.1)

API problem or error, as per RFC 7807 application/problem+json.

Properties

Name	Description
API Problem (v1.2.1)	object API problem or error, as per RFC 7807 application/problem+json.
type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". format: uri-reference maxLength: 2048
title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. format: text maxLength: 120
status	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048
id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. read-only format: date-time minLength: 20 maxLength: 30
problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

An challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

Name	Description
Challenge Factor (v1.2.1)	object An challenge factor. See requiredIdentityChallenge for multiple examples.
id	challengeFactorId The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor. Note: The id will become required in a future update to this schema. minLength: 3 maxLength: 48 pattern: ^[-a-zA-Z0-9$_]{3,48}$
type	challengeFactorType (required) The name of challenge factor. challengeFactorType strings may have one of the following enumerated values: Value Description sms SMS: One-time passcode sent to the primary mobile phone number email Email: One-time passcode sent to the primary email address voice Voice: One-time passcode communicated via automated voice phone call authenticatorToken authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app securityQuestions Security Questions: Prompt with the user's security questions registered with their security profile enum values: sms, email, voice, securityQuestions, authenticatorToken
labels	array: [string] A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address. minItems: 1 maxItems: 4 items: string(text) » format: text » maxLength: 300
securityQuestions	challengeSecurityQuestions Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

minLength: 3
maxLength: 48
pattern: ^[-a-zA-Z0-9$_]{3,48}$

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

Value	Description
sms	SMS: One-time passcode sent to the primary mobile phone number
email	Email: One-time passcode sent to the primary email address
voice	Voice: One-time passcode communicated via automated voice phone call
authenticatorToken	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestions	Security Questions: Prompt with the user's security questions registered with their security profile

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

minLength: 6
maxLength: 48
pattern: ^[-a-zA-Z0-9$_]{6,48}$

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

minLength: 1
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]+$

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

Name	Description
Challenge Security Question (v1.0.1)	object A single security question within the questions array of the challengeSecurityQuestions
id	challengePromptId (required) The unique ID of security question prompt. This should be included in the challengeVerification response as the promptId. minLength: 1 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]+$
prompt	string(text) (required) The text prompt of this security question. format: text maxLength: 80

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.1)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

Name	Description
Challenge Security Questions (v1.0.1)	object Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.
questions	array: [challengeSecurityQuestion] (required) The array of security questions. minItems: 1 maxItems: 8 items: object

compositeAnalyticFilter

{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ]
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ]
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ]
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ]
        }
      ]
    }
  ]
}

Composite Analytic Filter (v1.0.0)

A composite of analytic filter that are combined with a logical operator (and, or, not). For example, if primitiveFilters contains 3 filters p1, p2 and p2 and compositeFilters contains 2 filters c1, c2 and operator is and, the filter represents the expression ( p1 and p2 and p3 and c1 and c2 ). The example is equivalent to

( { customerType equals "retail" } or { customerAge between ["35", "49"] } or ( { customerRegion in [ "NC", "SC", "GA", "FL" ]} and { balance greaterThan "250000.00" } ) )

Note: there must be at least one item either the primitiveFilters array or the compositeFilters array.

Properties

Name	Description
Composite Analytic Filter (v1.0.0)	object A composite of analytic filter that are combined with a logical operator (and, or, not). For example, if primitiveFilters contains 3 filters p1, p2 and p2 and compositeFilters contains 2 filters c1, c2 and operator is and, the filter represents the expression ( p1 and p2 and p3 and c1 and c2 ). The example is equivalent to ( { customerType equals "retail" } or { customerAge between ["35", "49"] } or ( { customerRegion in [ "NC", "SC", "GA", "FL" ]} and { balance greaterThan "250000.00" } ) ) Note: there must be at least one item either the primitiveFilters array or the compositeFilters array.
operator	compositeFilterOperator The logical operator (and, or, not) used to combine the contained filters. enum values: and, or, not
primitiveFilters	array: [primitiveAnalyticFilter] An array of 0 or more primitive filters to be combined via the operator with each other and the compositeFilters. maxItems: 100 items: object
compositeFilters	array: [compositeAnalyticFilter] An array of 0 or more composite filters to be combined via the operator with each other and the primitiveFilters. maxItems: 100 items: object

compositeFilterOperator

"and"

Composite Filter Operator (v1.0.0)

An operator for combining filters in a composite filter.

compositeFilterOperator strings may have one of the following enumerated values:

Value	Description
and	And: A filter is true if all the nested filters evaluate to true.
or	Or: A filter is true if any one or more of the nested filters evaluate to true.
not	Not: A filter is true if none of the nested filters evaluate to true.

type: string

enum values: and, or, not

customerAudience

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": false,
    "share": false,
    "manageCollaborators": false,
    "manageFilters": false,
    "copy": true,
    "archive": false,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Customer Audience (v3.1.0)

Representation of customer audience resources.

Properties

Name	Description
Customer Audience (v3.1.0)	object Representation of customer audience resources.
createdAt	readOnlyTimestamp(date-time) (required) The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
updatedAt	readOnlyTimestamp(date-time) (required) The date-time when the resource was last updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
name	string(text) The name of this audience. format: text maxLength: 80
description	string(text) A detailed description of the audience. format: text maxLength: 500
customerType	customerAudienceCustomerType When used with the filter customer audience source, the customer type to use as the primary customer filter. This is implicitly combined with the other filters with an and operator. The default is all. When used with a list or insight customer audience source, the customer type is derived based on the audience customers. enum values: all, retail, commercial
filters	compositeAnalyticFilter One or more customer audiences filters that are combined with a logical operator (and, or, not). Note that the customer type filter is implicitly defined with the customerType property of the audience resource (it is also automatically combined with these filters with an and), so these filters should not include a customer type filter.
id	readOnlyResourceId (required) The unique identifier for this customer audience resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
state	customerAudienceState (required) The state of a Customer Audience customerAudienceState strings may have one of the following enumerated values: Value Description active Active: The audience is active and available for use. archived Archived: The audience is archived an not available for use. Archived audiences are deleted 30 days after being archived. enum values: active, archived
allows	customerAudienceAllows (required) Lists the actions the current analyst is allowed to perform on the current customer audience.
ownedBy	customerAudienceCollaborator (required) The analyst who owns this customer audience.
updatedBy	customerAudienceCollaborator The analyst who last updated this customer audience.
source	customerAudienceSource (required) The source used to create this audience. enum values: filter, insight, list
insightId	readOnlyResourceId The ID of the insight resource that this audience was derived from. This field is omitted if the audience was not created from an insight. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
fileName	customerAudienceFileName(text) The name of the file used to create this audience. This is available when the audience source is list. format: text minLength: 4 maxLength: 255
customerCount	integer(int32) (required) The number of customers who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
totalCustomerCount	integer(int32) (required) The total number of customers at the financial institution, ignoring any filter criteria. format: int32 minimum: 0 maximum: 1000000000
customerCountUpdatedAt	timestamp(date-time) (required) The timestamp when the customerCount was last updated, in RFC 3339 UTC YYYY-MM-DDThh:mm:ss.sssZ date-time format. format: date-time minLength: 20 maxLength: 30
collaborators	array: [customerAudienceCollaborator] (required) An array containing customer audience collaborators. Update this value with the patchCustomerAudienceCollaborators operation. read-only maxItems: 2000 items: object

customerAudienceAllows

{
  "edit": false,
  "share": false,
  "manageCollaborators": false,
  "manageFilters": true,
  "copy": true,
  "archive": false,
  "restore": false
}

Customer Audience Allows (v1.0.2)

Lists the actions the current analyst is allowed to perform on the current customer audience.

Properties

Name	Description
Customer Audience Allows (v1.0.2)	object Lists the actions the current analyst is allowed to perform on the current customer audience.
edit	boolean The analyst is allowed to edit this audience. Editing is limited to changing the name, description, and collaborators (not the filters) if this audience was derived from from an insight. For an audience imported with a list source, edit allows updating the list via updateCustomerAudienceCustomerIds.
share	boolean The analyst is allowed to share this audience with other collaborator analysts.
manageCollaborators	boolean The analyst is allowed to manage the collaborators (share/unshare) this audience.
manageFilters	boolean The analyst is allowed to manage the filters of this audience. This is always false if the audience was instantiated from an insight or if the audience was created by importing a static list of customer IDs.
copy	boolean The analyst is allowed to copy this audience. This is always false if the audience was instantiated from an insight.
archive	boolean The analyst may archive this audience. If the audiences' state is archived, this is always false.
restore	boolean The analyst may restore (unarchive) this audience. If the audiences' state is active, this is always false.

customerAudienceCollaborator

{
  "id": "0399abedfd3d",
  "firstName": "Bob",
  "lastName": "Hartley",
  "username": "bhartley"
}

Customer Audience Collaborator (v2.0.1)

A collaborator that a customer audience resource has been shared with. This customer audience appears in the listCustomerAudiences response for each collaborator, and their allows object will determine what operations the collaborator may use.

Properties

Name	Description
Customer Audience Collaborator (v2.0.1)	object A collaborator that a customer audience resource has been shared with. This customer audience appears in the listCustomerAudiences response for each collaborator, and their allows object will determine what operations the collaborator may use.
id	resourceId (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
firstName	string(text) (required) The user's first name. format: text maxLength: 56
lastName	string(text) (required) The user's last name. format: text maxLength: 56
username	customerUsername(text) (required) The user's login name. format: text maxLength: 20

customerAudienceCollaboratorPatch

{
  "id": "0744e9280e32664dccfe"
}

Customer Audience Collaborator Patch (v1.0.0)

A collaborator item in a patch to an audience's collaborators.

Properties

Name	Description
Customer Audience Collaborator Patch (v1.0.0)	object A collaborator item in a patch to an audience's collaborators.
id	resourceId The immutable, unique, opaque identifier for the collaborator. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

customerAudienceCollaborators

{}

Customer Audience Collaborators (v2.0.1)

A list of collaborators that this audience resource has been shared with. Manage collaborators with the patchCustomerAudienceCollaborator operation.

Properties

Name	Description
Customer Audience Collaborators (v2.0.1)	object A list of collaborators that this audience resource has been shared with. Manage collaborators with the patchCustomerAudienceCollaborator operation.
items	array: [customerAudienceCollaborator] (required) An array containing customer audience collaborator items. maxItems: 2000 items: object

customerAudienceCollaboratorsPatch

{
  "items": [
    {
      "id": "0399abedfd3d"
    },
    {
      "id": "969461d0b4c74577a8db"
    },
    {
      "id": "00c18c57fbfe92a38ed3"
    },
    {
      "id": "7b66f63c979b908e9e37"
    },
    {
      "id": "4cb851e85606f4e44c53"
    }
  ]
}

Customer Audience Collaborators Patch (v1.0.0)

Request body to update an audience's list of collaborators.

Properties

Name	Description
Customer Audience Collaborators Patch (v1.0.0)	object Request body to update an audience's list of collaborators.
items	array: [customerAudienceCollaboratorPatch] (required) An array containing a list of collaborators for a customer audience. maxItems: 2000 items: object

customerAudienceCounts

{
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z"
}

Customer Audience Counts (v1.0.0)

The count of customers who meet the criteria of the given customer audience filters.

Properties

Name	Description
Customer Audience Counts (v1.0.0)	object The count of customers who meet the criteria of the given customer audience filters.
customerCount	integer(int32) (required) The number of customers who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
totalCustomerCount	integer(int32) (required) The total number of customers at the financial institution, ignoring any filter criteria. format: int32 minimum: 0 maximum: 1000000000
customerCountUpdatedAt	timestamp(date-time) (required) The timestamp when the customerCount was last updated, in RFC 3339 UTC YYYY-MM-DDThh:mm:ss.sssZ date-time format. format: date-time minLength: 20 maxLength: 30

customerAudienceCustomerIdsImport

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "fileName": "2023_18to35_north_carolina.csv"
}

Customer Audience Import (v1.1.0)

A request to import a values file of customers for a customer audience.

Properties

Name	Description
Customer Audience Import (v1.1.0)	object A request to import a values file of customers for a customer audience.
identifierType	customerAudienceImportIdentifierType (required) The type of the field used for importing customer audience customers. customerAudienceImportIdentifierType strings may have one of the following enumerated values: Value Description username Username: The import contains the login usernames of financial institution customers customerId Customer ID: The import contains the customer IDs of financial institution customers taxIdNumber Tax ID Number: The import contains the tax identifiers of financial institution customers, such as social security number (SSN) or employer identification number (EIN) enum values: username, customerId, taxIdNumber
includesHeader	boolean (required) Indicates whether the customer audience IDs file includes a header row or not.
fileName	customerAudienceFileName(text) The name of the file used to create this audience. This is available when the audience source is list. format: text minLength: 4 maxLength: 255
content	string(byte) (required) The Base64-encoded content containing the identifiers for customers to include in a customer audience. The import allows comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx format) files. The maximum length constraint allows for a (non-Base64 encoded) input file of at most 6,500,000 bytes. format: byte maxLength: 8905000

customerAudienceCustomerType

"all"

Customer Audience Customer Type (v1.0.0)

Selects the customer type to use as the primary customer filter.

customerAudienceCustomerType strings may have one of the following enumerated values:

Value	Description
all	All Customers: All customers/members at the financial institution
retail	Retail Customers: Retail (personal) banking customers/members at the financial institution
commercial	Commercial Customers: Commercial (business) banking customers/members at the financial institution

type: string

enum values: all, retail, commercial

customerAudienceFileName

"2023_18to35_north_carolina.csv"

Customer Audience File Name (v1.0.0)

The name of the file used to create this audience. This is available when the audience source is list.

type: string(text)

format: text
minLength: 4
maxLength: 255

customerAudienceFilters

{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ]
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ]
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ]
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ]
        }
      ]
    }
  ]
}

Customer Audience Filters (v1.0.0)

A set of filters which define a customer audience.

Properties

Name	Description
Customer Audience Filters (v1.0.0)	object A set of filters which define a customer audience.
operator	compositeFilterOperator The logical operator (and, or, not) used to combine the contained filters. enum values: and, or, not
primitiveFilters	array: [primitiveAnalyticFilter] An array of 0 or more primitive filters to be combined via the operator with each other and the compositeFilters. maxItems: 100 items: object
compositeFilters	array: [compositeAnalyticFilter] An array of 0 or more composite filters to be combined via the operator with each other and the primitiveFilters. maxItems: 100 items: object

customerAudienceIds

{
  "count": 189,
  "items": [
    "9dfb049f5672424d7b3b",
    "f26c043c527f42430b15",
    "40ce35bd15417a2e2a09",
    "c84fd4b81049c27d4a65",
    "b8e93bb1bd22dba4093c",
    "c5247e8f5de1a4e79f67",
    "5e979274f87e41eee739",
    "6dc7c36cb2306288919f",
    "09c8fdf03607d0e12c91",
    "c50aae5d1be0ad19ca5b"
  ],
  "nextPage_url": "https://production.api.apiture.com/bankingAdmin/customerAudiences/customerIds?start=74f96e77c3aafcb9fe85?limit=10"
}

Customer Audience IDs (v1.0.0)

A page of the customer IDs for an audience.

Properties

Name	Description
Customer Audience IDs (v1.0.0)	object A page of the customer IDs for an audience.
items	array: [resourceId] The array of customer IDs. maxItems: 100000 items: string » minLength: 6 » maxLength: 48 » pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
count	integer(int32) The total number of customers which satisfy this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
nextPage_url	string(uri-reference) The URL of the next page of customer IDs. If this URL is omitted, there are no more customer IDs. read-only format: uri-reference maxLength: 256

customerAudienceImport

{
  "identifierType": "taxIdNumber",
  "includesHeader": false,
  "content": "QmFzZS02NCBlbmNvZGVkIENTViBjb250ZW50IGhlcmUuLi4=",
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "fileName": "2023_18to35_north_carolina.csv"
}

Customer Audience Import (v1.1.0)

A request to create a new customer audience from a file of customer audience IDs.

Properties

Name	Description
Customer Audience Import (v1.1.0)	object A request to create a new customer audience from a file of customer audience IDs.
name	string(text) (required) The name of this audience. format: text maxLength: 80
description	string(text) (required) A detailed description of the audience. format: text maxLength: 500
identifierType	customerAudienceImportIdentifierType (required) The type of the field used for importing customer audience customers. customerAudienceImportIdentifierType strings may have one of the following enumerated values: Value Description username Username: The import contains the login usernames of financial institution customers customerId Customer ID: The import contains the customer IDs of financial institution customers taxIdNumber Tax ID Number: The import contains the tax identifiers of financial institution customers, such as social security number (SSN) or employer identification number (EIN) enum values: username, customerId, taxIdNumber
includesHeader	boolean (required) Indicates whether the customer audience IDs file includes a header row or not.
fileName	customerAudienceFileName(text) (required) The name of the file used to create this audience. This is available when the audience source is list. format: text minLength: 4 maxLength: 255
content	string(byte) (required) The Base64-encoded content containing the identifiers for customers to include in a customer audience. The import allows comma-separated values (CSV), plain text, and Microsoft Excel (.xls and .xlsx format) files. The maximum length constraint allows for a (non-Base64 encoded) input file of at most 6,500,000 bytes. format: byte maxLength: 8905000

customerAudienceImportIdentifierType

"username"

Customer Audience Import Identifier Type (v1.0.0)

The type of the field used for importing customer audience customers.

customerAudienceImportIdentifierType strings may have one of the following enumerated values:

Value	Description
username	Username: The import contains the login usernames of financial institution customers
customerId	Customer ID: The import contains the customer IDs of financial institution customers
taxIdNumber	Tax ID Number: The import contains the tax identifiers of financial institution customers, such as social security number (SSN) or employer identification number (EIN)

type: string

enum values: username, customerId, taxIdNumber

customerAudienceItem

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": false,
    "share": false,
    "manageCollaborators": false,
    "manageFilters": false,
    "copy": true,
    "archive": false,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Customer Audience Item (v3.1.0)

Summary representation of a customer audience resource in the customer audiences collection. To fetch the full representation of this customer audience, use the getCustomerAudience operation, passing this item's id field as the customerAudienceId path parameter.

Properties

Name	Description
Customer Audience Item (v3.1.0)	object Summary representation of a customer audience resource in the customer audiences collection. To fetch the full representation of this customer audience, use the getCustomerAudience operation, passing this item's id field as the customerAudienceId path parameter.
createdAt	readOnlyTimestamp(date-time) (required) The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
updatedAt	readOnlyTimestamp(date-time) (required) The date-time when the resource was last updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
name	string(text) The name of this audience. format: text maxLength: 80
description	string(text) A detailed description of the audience. format: text maxLength: 500
customerType	customerAudienceCustomerType When used with the filter customer audience source, the customer type to use as the primary customer filter. This is implicitly combined with the other filters with an and operator. The default is all. When used with a list or insight customer audience source, the customer type is derived based on the audience customers. enum values: all, retail, commercial
filters	compositeAnalyticFilter A composite of analytic filter that are combined with a logical operator (and, or, not). For example, if primitiveFilters contains 3 filters p1, p2 and p2 and compositeFilters contains 2 filters c1, c2 and operator is and, the filter represents the expression ( p1 and p2 and p3 and c1 and c2 ). The example is equivalent to ( { customerType equals "retail" } or { customerAge between ["35", "49"] } or ( { customerRegion in [ "NC", "SC", "GA", "FL" ]} and { balance greaterThan "250000.00" } ) ) Note: there must be at least one item either the primitiveFilters array or the compositeFilters array.
id	readOnlyResourceId (required) The unique identifier for this customer audience resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
state	customerAudienceState (required) The state of a Customer Audience customerAudienceState strings may have one of the following enumerated values: Value Description active Active: The audience is active and available for use. archived Archived: The audience is archived an not available for use. Archived audiences are deleted 30 days after being archived. enum values: active, archived
allows	customerAudienceAllows (required) Lists the actions the current analyst is allowed to perform on the current customer audience.
ownedBy	customerAudienceCollaborator (required) The analyst who owns this customer audience.
updatedBy	customerAudienceCollaborator The analyst who last updated this customer audience.
source	customerAudienceSource (required) The source used to create this audience. enum values: filter, insight, list
insightId	readOnlyResourceId The ID of the insight resource that this audience was derived from. This field is omitted if the audience was not created from an insight. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
fileName	customerAudienceFileName(text) The name of the file used to create this audience. This is available when the audience source is list. format: text minLength: 4 maxLength: 255
customerCount	integer(int32) (required) The number of customers who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
totalCustomerCount	integer(int32) (required) The total number of customers at the financial institution, ignoring any filter criteria. format: int32 minimum: 0 maximum: 1000000000
customerCountUpdatedAt	timestamp(date-time) (required) The timestamp when the customerCount was last updated, in RFC 3339 UTC YYYY-MM-DDThh:mm:ss.sssZ date-time format. format: date-time minLength: 20 maxLength: 30
collaborators	array: [customerAudienceCollaborator] (required) An array containing up to the first 16 customer audience collaborators. Update this value with the patchCustomerAudienceCollaborators operation. Within the list of customer audiences returned from listCustomerAudiences, this list is limited to the first 16 collaborators. The full list is available in the full customerAudience response from the getCustomerAudience or from listCustomerAudienceCollaborators. read-only maxItems: 16 items: object
collaboratorsCount	integer(int32) (required) The total number of collaborators on this customer audience. The full list is available in the listCustomerAudienceCollaborators response. format: int32 minimum: 0 maximum: 2000

customerAudiencePatch

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail"
}

Customer Audience Patch (v1.1.0)

Request to patch a customer audience resources.

Properties

Name	Description
Customer Audience Patch (v1.1.0)	object Request to patch a customer audience resources.
name	string(text) The name of this audience. format: text maxLength: 80
description	string(text) A detailed description of the audience. format: text maxLength: 500
customerType	customerAudienceCustomerType When used with the filter customer audience source, the customer type to use as the primary customer filter. This is implicitly combined with the other filters with an and operator. The default is all. When used with a list or insight customer audience source, the customer type is derived based on the audience customers. enum values: all, retail, commercial
filters	compositeAnalyticFilter One or more customer audiences filters that are combined with a logical operator (and, or, not). Note that the customer type filter is implicitly defined with the customerType property of the audience resource (it is also automatically combined with these filters with an and), so these filters should not include a customer type filter.

customerAudienceSource

"filter"

Customer Audience Source (v1.0.0)

The source or origin of the customers in a customer audience.

customerAudienceSource strings may have one of the following enumerated values:

Value	Description
filter	Filter: The audience was created from a set of filters
insight	Insight: The audience was created from an insight
list	List: The audience was created from importing a list of customer IDs

type: string

enum values: filter, insight, list

customerAudienceState

"active"

Customer Audience State (v1.0.0)

The state of a Customer Audience

customerAudienceState strings may have one of the following enumerated values:

Value	Description
active	Active: The audience is active and available for use.
archived	Archived: The audience is archived an not available for use. Archived audiences are deleted 30 days after being archived.

type: string

enum values: active, archived

customerAudiences

{
  "items": [
    {
      "name": "New Customers Ages 35-49",
      "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
      "customerType": "retail",
      "customerCount": 12340,
      "totalCustomerCount": 2340659,
      "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
      "id": "0399abedfd3d",
      "state": "active",
      "createdAt": "2023-04-14T06:47:53.375Z",
      "updatedAt": "2023-04-24T08:48:05.000Z",
      "source": "list",
      "allows": {
        "edit": false,
        "share": false,
        "manageCollaborators": false,
        "manageFilters": false,
        "copy": true,
        "archive": false,
        "restore": false
      },
      "ownedBy": {
        "id": "0399abedfd3d",
        "firstName": "Bob",
        "lastName": "Hartley",
        "username": "bhartley"
      },
      "updatedBy": {
        "id": "0399abedfd3d",
        "firstName": "Bob",
        "lastName": "Hartley",
        "username": "bhartley"
      },
      "collaborators": [
        {
          "id": "0399abedfd3d",
          "firstName": "Bob",
          "lastName": "Hartley",
          "username": "bhartley"
        },
        {
          "id": "389a2238d9f5c275d172",
          "firstName": "Carol",
          "lastName": "Wallace",
          "username": "cwallace"
        },
        {
          "id": "69fdb75ba971f3291432",
          "firstName": "Jerry",
          "lastName": "Robinson",
          "username": "jrobinson"
        }
      ]
    }
  ]
}

Customer Audience Collection (v3.1.0)

Collection of customer audiences. The items in the collection are ordered in the items array.

Properties

Name	Description
Customer Audience Collection (v3.1.0)	object Collection of customer audiences. The items in the collection are ordered in the items array.
items	array: [customerAudienceItem] (required) An array containing customer audience items. maxItems: 2000 items: object

customerUsername

"string"

Customer Username (v1.0.0)

A customer's login username.

type: string(text)

format: text
maxLength: 20

dataAnalyst

{
  "id": "0399abedfd3d",
  "firstName": "Bob",
  "lastName": "Hartley",
  "username": "bhartley"
}

Data Analyst (v2.0.1)

A person who uses data analysis products.

Properties

Name	Description
Data Analyst (v2.0.1)	object A person who uses data analysis products.
id	resourceId (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
firstName	string(text) (required) The user's first name. format: text maxLength: 56
lastName	string(text) (required) The user's last name. format: text maxLength: 56
username	customerUsername(text) (required) The user's login name. format: text maxLength: 20

dataAnalysts

{
  "items": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ]
}

Data Analysts (v2.0.1)

A list of active data data analysts people at the financial institution.

Properties

Name	Description
Data Analysts (v2.0.1)	object A list of active data data analysts people at the financial institution.
items	array: [dataAnalyst] (required) An array containing customer audience collaborator items. maxItems: 10000 items: object

importedCustomerAudience

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail",
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "customerCountUpdatedAt": "2023-04-24T08:48:05.000Z",
  "id": "0399abedfd3d",
  "state": "active",
  "createdAt": "2023-04-14T06:47:53.375Z",
  "updatedAt": "2023-04-24T08:48:05.000Z",
  "source": "list",
  "allows": {
    "edit": true,
    "share": true,
    "manageCollaborators": true,
    "manageFilters": false,
    "copy": true,
    "archive": true,
    "restore": false
  },
  "ownedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "updatedBy": {
    "id": "0399abedfd3d",
    "firstName": "Bob",
    "lastName": "Hartley",
    "username": "bhartley"
  },
  "collaborators": [
    {
      "id": "0399abedfd3d",
      "firstName": "Bob",
      "lastName": "Hartley",
      "username": "bhartley"
    },
    {
      "id": "389a2238d9f5c275d172",
      "firstName": "Carol",
      "lastName": "Wallace",
      "username": "cwallace"
    },
    {
      "id": "69fdb75ba971f3291432",
      "firstName": "Jerry",
      "lastName": "Robinson",
      "username": "jrobinson"
    }
  ],
  "unmatchedCount": 2,
  "unmatchedIds": [
    "c50aae5d1be0ad19ca5b",
    "f26c0-43c527f42430b15"
  ],
  "fileName": "2023_18to35_north_carolina.csv"
}

Imported Customer Audience (v3.1.0)

The result from importing a list of customer audience customers from a file.

Properties

Name	Description
Imported Customer Audience (v3.1.0)	object The result from importing a list of customer audience customers from a file.
createdAt	readOnlyTimestamp(date-time) (required) The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
updatedAt	readOnlyTimestamp(date-time) (required) The date-time when the resource was last updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable. read-only format: date-time minLength: 20 maxLength: 30
name	string(text) The name of this audience. format: text maxLength: 80
description	string(text) A detailed description of the audience. format: text maxLength: 500
customerType	customerAudienceCustomerType When used with the filter customer audience source, the customer type to use as the primary customer filter. This is implicitly combined with the other filters with an and operator. The default is all. When used with a list or insight customer audience source, the customer type is derived based on the audience customers. enum values: all, retail, commercial
filters	compositeAnalyticFilter One or more customer audiences filters that are combined with a logical operator (and, or, not). Note that the customer type filter is implicitly defined with the customerType property of the audience resource (it is also automatically combined with these filters with an and), so these filters should not include a customer type filter.
id	readOnlyResourceId (required) The unique identifier for this customer audience resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
state	customerAudienceState (required) The state of a Customer Audience customerAudienceState strings may have one of the following enumerated values: Value Description active Active: The audience is active and available for use. archived Archived: The audience is archived an not available for use. Archived audiences are deleted 30 days after being archived. enum values: active, archived
allows	customerAudienceAllows (required) Lists the actions the current analyst is allowed to perform on the current customer audience.
ownedBy	customerAudienceCollaborator (required) The analyst who owns this customer audience.
updatedBy	customerAudienceCollaborator The analyst who last updated this customer audience.
source	customerAudienceSource (required) The source used to create this audience. enum values: filter, insight, list
insightId	readOnlyResourceId The ID of the insight resource that this audience was derived from. This field is omitted if the audience was not created from an insight. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
fileName	customerAudienceFileName(text) The name of the file used to create this audience. This is available when the audience source is list. format: text minLength: 4 maxLength: 255
customerCount	integer(int32) (required) The number of customers who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
totalCustomerCount	integer(int32) (required) The total number of customers at the financial institution, ignoring any filter criteria. format: int32 minimum: 0 maximum: 1000000000
customerCountUpdatedAt	timestamp(date-time) (required) The timestamp when the customerCount was last updated, in RFC 3339 UTC YYYY-MM-DDThh:mm:ss.sssZ date-time format. format: date-time minLength: 20 maxLength: 30
collaborators	array: [customerAudienceCollaborator] (required) An array containing customer audience collaborators. Update this value with the patchCustomerAudienceCollaborators operation. read-only maxItems: 2000 items: object
unmatchedCount	integer(int32) The count of identifiers that are unable to be matched to customers for this audience. format: int32 minimum: 0 maximum: 1000000
unmatchedIds	array: [string] List of customer identifiers that were unable to be matched. This list is limited to the first 1,000 unmatched IDs. Identifiers longer than 50 characters may be truncated. maxItems: 1000 items: string(text) » format: text » maxLength: 50

newCustomerAudience

{
  "name": "New Customers Ages 35-49",
  "description": "New customers added within the last 60 days who are in the 35-49 years age group.",
  "customerType": "retail"
}

New Customer Audience (v1.1.0)

Representation used to create a new customer audience.

Properties

Name	Description
New Customer Audience (v1.1.0)	object Representation used to create a new customer audience.
name	string(text) (required) The name of this audience. format: text maxLength: 80
description	string(text) (required) A detailed description of the audience. format: text maxLength: 500
customerType	customerAudienceCustomerType When used with the filter customer audience source, the customer type to use as the primary customer filter. This is implicitly combined with the other filters with an and operator. The default is all. When used with a list or insight customer audience source, the customer type is derived based on the audience customers. enum values: all, retail, commercial
filters	compositeAnalyticFilter One or more customer audiences filters that are combined with a logical operator (and, or, not). Note that the customer type filter is implicitly defined with the customerType property of the audience resource (it is also automatically combined with these filters with an and), so these filters should not include a customer type filter.

primitiveAnalyticFilter

{
  "filterType": {
    "id": "6b3927745edec398ad74",
    "name": "customerAge"
  },
  "operator": "between",
  "values": [
    "35",
    "49"
  ]
}

Primitive Analytic Filter (v1.0.0)

A primitive analytic filter that compares constant values to a data measurement within an audience data measure and returns a boolean value.

Properties

Name	Description
Primitive Analytic Filter (v1.0.0)	object A primitive analytic filter that compares constant values to a data measurement within an audience data measure and returns a boolean value.
filterType	analyticFilterTypeReference (required) The name and id of the filter type that this filter is an instance of.
operator	analyticFilterOperatorType (required) The name of the filter operator to apply to the measure associated with the filter type and the optional filter values. This is one of the operators in the corresponding filter type. enum values: equals, notEquals, lessThan, lessThanOrEqualTo, greaterThan, greaterThanOrEqualTo, before, after, between, notBetween, in, notIn
values	array: [analyticFilterValue] (required) The constant values to compare the measure to. The number of values in this array must be within the minimumValues and maximumValues constraints in the named filter type. Thus array is required but may be an empty array [] if the corresponding analytic filter's minimumValues is 0. maxItems: 1000 items: string(text) » format: text » maxLength: 200

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists for the given account reference",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.4.1)

API problem or error response, as per RFC 9457 application/problem+json.

Properties

Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". format: uri-reference maxLength: 2048
title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. format: text maxLength: 120
status	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048
id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. read-only format: date-time minLength: 20 maxLength: 30
problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object
attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string

read-only
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)

read-only
format: date-time
minLength: 20
maxLength: 30

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ],
      "id": "85c0ee5753fcd0b0953f"
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ],
      "id": "d089e10a80a8627df37b"
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ],
      "id": "10506ecf9d1c2ee00403"
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ],
      "id": "e917d671cb2f030b56f1"
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ],
      "id": "fe6c452d7da0bbb4e407"
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      },
      "id": "df33c6f88a37d6b3f0a6"
    }
  ]
}

Required Challenge (v1.2.3)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

Name	Description
Required Challenge (v1.2.3)	object A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.
operationId	challengeOperationId (required) The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses. minLength: 6 maxLength: 48 pattern: ^[-a-zA-Z0-9$_]{6,48}$
challengeId	readOnlyResourceId (required) The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
factors	array: [challengeFactor] (required) A list of challenge factors. The user must complete one of these challenge factors. The labels in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an sms factor and a voice factor. minItems: 1 maxItems: 8 items: object

resourceId

"string"

Resource Identifier (v1.0.1)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string

minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$

timestamp

"2021-10-30T19:06:04.250Z"

Timestamp (v1.0.0)

A timestamp (an instant in time) formatted in YYYY-MM-DDThh:mm:ss.sssZ RFC 3339 date-time UTC format.

type: string(date-time)

format: date-time
minLength: 20
maxLength: 30

userAccountReference

{
  "id": "0399abed-fd3d",
  "firstName": "Benny",
  "lastName": "Billings",
  "username": "bbillings"
}

User Account Reference (v1.0.2)

The representation of a user account.

Properties

Name	Description
User Account Reference (v1.0.2)	object The representation of a user account.
id	resourceId (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
firstName	string(text) (required) The user's first name. format: text maxLength: 56
lastName	string(text) (required) The user's last name. format: text maxLength: 56
username	customerUsername(text) (required) The user's login name. format: text maxLength: 20

validatedCustomerAudience

{
  "customerCount": 12340,
  "totalCustomerCount": 2340659,
  "unmatchedCount": 0,
  "unmatchedIds": []
}

Validated Customer Audience (v1.0.0)

The result from validating a list of customer audience customers from a file.

Properties

Name	Description
Validated Customer Audience (v1.0.0)	object The result from validating a list of customer audience customers from a file.
unmatchedCount	integer(int32) (required) The count of identifiers that are unable to be matched to customers for this audience. format: int32 minimum: 0 maximum: 1000000
unmatchedIds	array: [string] (required) List of customer identifiers that were unable to be matched. This list is limited to the first 1,000 unmatched IDs. Identifiers longer than 50 characters may be truncated. maxItems: 1000 items: string(text) » format: text » maxLength: 50
customerCount	integer(int32) (required) The number of customers who match this audience's filter criteria. format: int32 minimum: 0 maximum: 1000000000
totalCustomerCount	integer(int32) (required) The total number of customers at the financial institution, ignoring any filter criteria. format: int32 minimum: 0 maximum: 1000000000

---