Identity

API

getApi

Top-level resources and operations in this API

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


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/"
import { APIApi } from "@apiture/identity-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Identity.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/apiDoc"
import { APIApi } from "@apiture/identity-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Identity.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


Approvals

createApproval

Create a new approval resource

Create a new approval resource for the specified Contact. The following links may be included in a successful response under the `_links` property: * `self`: URI of the created approval resource - `/approvals/{approvalId}` * `apiture:contact`: If the specified contactUri param refers to a Contact resource a link to it will be present


/approvals

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///identity/approvals?contactUri=&type="
import { ApprovalsApi } from "@apiture/identity-client-sdk";

const approvalsApi = new ApprovalsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
approvalsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
approvalsApi.setApiKey(apiKey);


var api = new Identity.ApprovalsApi.createApproval()
var contactUri = contactUri_example; // {String} The `apiture:contact` URI.
var opts = {
  'type': type_example // {String} The identity method type. Possible values are `fraudRiskReport`, `quiz` or `adminApproval`.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
approvalsApi.createApproval(contactUri, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Query parameters
Name Description
contactUri*
String
The `apiture:contact` URI.
Required
type
String
The identity method type. Possible values are `fraudRiskReport`, `quiz` or `adminApproval`.

Responses

Name Type Format Description
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`schema`*`://host`


getApproval

Fetch a representation of this approval

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this approval resource. The following links will be included in a successful response under the `_links` property: * `self`: URI of the this fraud-risk report resource - `/approvals/{approvalId}` * `apiture:contact`: If the specified contactUri param refers to a Contact resource a link to it will be present


/approvals/{approvalId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/approvals/{approvalId}"
import { ApprovalsApi } from "@apiture/identity-client-sdk";

const approvalsApi = new ApprovalsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
approvalsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
approvalsApi.setApiKey(apiKey);


var api = new Identity.ApprovalsApi.getApproval()
var approvalId = approvalId_example; // {String} The unique identifier of this approval. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
approvalsApi.getApproval(approvalId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
approvalId*
String
The unique identifier of this approval. This is an opaque string.
Required

Responses


FraudRiskReports

createFraudRiskReport

Create a new fraud-risk analysis report

Create a new fraud-risk analysis report in the fraud-risk analysis reports collection. If an `apiture:contact` link is specified in the request a verification token will be returned in the response. If an `apiture:contact` link is invalid a 400 Bad Request response will be returned. The following links will be included in a successful response under the `_links` property: * `self`: URI of the created fraud-risk report resource - `/fraudRiskReports/{fraudRiskReportId}` * `apiture:contact`: If the resource was created with an `apiture:contact` a link to the specified resource will be present


/fraudRiskReports

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///identity/fraudRiskReports"
import { FraudRiskReportsApi } from "@apiture/identity-client-sdk";

const fraudRiskReportsApi = new FraudRiskReportsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fraudRiskReportsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fraudRiskReportsApi.setApiKey(apiKey);


var api = new Identity.FraudRiskReportsApi.createFraudRiskReport()
var createFraudRiskReport = ; // {CreateFraudRiskReport} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fraudRiskReportsApi.createFraudRiskReport(createFraudRiskReport, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Body parameters
Name Description
createFraudRiskReport *

The identity

Responses

Name Type Format Description
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`schema`*`://host`


getFraudRiskReport

Fetch a representation of this fraud-risk report

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this fraud-risk analysis report resource. The following links will be included in a successful response under the `_links` property: * `self`: URI of the this fraud-risk report resource - `/fraudRiskReports/{fraudRiskReportId}` * `apiture:contact`: If the resource was created with an `apiture:contact` a link to the specified resource will be present


/fraudRiskReports/{fraudRiskReportId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/fraudRiskReports/{fraudRiskReportId}"
import { FraudRiskReportsApi } from "@apiture/identity-client-sdk";

const fraudRiskReportsApi = new FraudRiskReportsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fraudRiskReportsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fraudRiskReportsApi.setApiKey(apiKey);


var api = new Identity.FraudRiskReportsApi.getFraudRiskReport()
var fraudRiskReportId = fraudRiskReportId_example; // {String} The unique identifier of this fraud-risk report. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fraudRiskReportsApi.getFraudRiskReport(fraudRiskReportId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
fraudRiskReportId*
String
The unique identifier of this fraud-risk report. This is an opaque string.
Required

Responses


getFraudRiskReports

Returns a collection of fraud-risk analysis results

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of fraud-risk analysis reports.The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/fraudRiskReports

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/fraudRiskReports?start=&limit=&sortBy=&filter=&q=&type="
import { FraudRiskReportsApi } from "@apiture/identity-client-sdk";

const fraudRiskReportsApi = new FraudRiskReportsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fraudRiskReportsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fraudRiskReportsApi.setApiKey(apiKey);


var api = new Identity.FraudRiskReportsApi.getFraudRiskReports()
var opts = {
  'start': 789, // {Long} The zero-based index of the first fraud-risk analysis report in this page. The default, 0, represents the first report in the collection.
  'limit': 56, // {Integer} The maximum number of fraud-risk analysis report representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'type': type_example // {String} Subset the fraud reports collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment` Account matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fraudRiskReportsApi.getFraudRiskReports(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first fraud-risk analysis report in this page. The default, 0, represents the first report in the collection.
limit
Integer (int32)
The maximum number of fraud-risk analysis report representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
type
String
Subset the fraud reports collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment` Account matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


Quizzes

createQuiz

Create a new quiz

Create a new quiz in the quizzes collection for the specified identity. `state` defaults to `pending` If the apiture:contact` link is invalid a 400 Bad Request response will be returned. The following links will be included in a successful response under the `_links` property: * `self`: URI of the created quiz resource - `/quizzes/{quizId}` * `apiture:contact`: If the resource was created with an `apiture:contact` a link to the specified resource will be present


/quizzes

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///identity/quizzes"
import { QuizzesApi } from "@apiture/identity-client-sdk";

const quizzesApi = new QuizzesApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
quizzesApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
quizzesApi.setApiKey(apiKey);


var api = new Identity.QuizzesApi.createQuiz()
var createQuiz = ; // {CreateQuiz} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
quizzesApi.createQuiz(createQuiz, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Body parameters
Name Description
createQuiz *

The identity

Responses

Name Type Format Description
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`schema`*`://host`


createQuizQuestions

Generate the questions for a quiz

Generates the a set of questions for the quiz. Questions can only be generated if the state of the resource is `pending`. The following links will be included in a successful response under the `_links` property: * `up`: URI of the quiz resource - `/quizzes/{quizId}` * `apiture:score`: URI of the `/quizzes/{quizId}/answers` endpoint * `apiture:contact`: If the resource was created with a `apiture:contact` a link to the specified resource will be present


/quizzes/{quizId}/questions

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///identity/quizzes/{quizId}/questions"
import { QuizzesApi } from "@apiture/identity-client-sdk";

const quizzesApi = new QuizzesApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
quizzesApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
quizzesApi.setApiKey(apiKey);


var api = new Identity.QuizzesApi.createQuizQuestions()
var quizId = quizId_example; // {String} The unique identifier of this quiz. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
quizzesApi.createQuizQuestions(quizId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
quizId*
String
The unique identifier of this quiz. This is an opaque string.
Required

Responses


getQuiz

Fetch a representation of this quiz

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this quiz resource. The following links will be included in a successful response under the `_links` property: * `self`: URI of the this quiz resource - `/quizzes/{quizId}` * `apiture:contact`: If the resource was created with an `apiture:contact` a link to the specified resource will be present


/quizzes/{quizId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/quizzes/{quizId}"
import { QuizzesApi } from "@apiture/identity-client-sdk";

const quizzesApi = new QuizzesApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
quizzesApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
quizzesApi.setApiKey(apiKey);


var api = new Identity.QuizzesApi.getQuiz()
var quizId = quizId_example; // {String} The unique identifier of this quiz. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
quizzesApi.getQuiz(quizId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
quizId*
String
The unique identifier of this quiz. This is an opaque string.
Required

Responses


getQuizzes

Returns a collection of quizzes

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of quizzes. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/quizzes

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/quizzes?start=&limit=&sortBy=&filter=&q="
import { QuizzesApi } from "@apiture/identity-client-sdk";

const quizzesApi = new QuizzesApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
quizzesApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
quizzesApi.setApiKey(apiKey);


var api = new Identity.QuizzesApi.getQuizzes()
var opts = {
  'start': 789, // {Long} The zero-based index of the first quiz in this page.
The default, 0, represents the first report in the collection.
  'limit': 56, // {Integer} The maximum number of quiz representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
quizzesApi.getQuizzes(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first quiz in this page. The default, 0, represents the first report in the collection.
limit
Integer (int32)
The maximum number of quiz representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


scoreQuiz

Submit the answers to a quiz

Submits the answers for scoring and returns the quiz with a state of `passed`, `failed`, `scoring` or `expired`. Can only be processed if state is `asked`. The following links will be included in a successful response under the `_links` property: * `up`: URI of the quiz resource - `/quizzes/{quizId}` * `apiture:contact`: If the resource was created with a `apiture:contact` a link to the specified resource will be present


/quizzes/{quizId}/answers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///identity/quizzes/{quizId}/answers"
import { QuizzesApi } from "@apiture/identity-client-sdk";

const quizzesApi = new QuizzesApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
quizzesApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
quizzesApi.setApiKey(apiKey);


var api = new Identity.QuizzesApi.scoreQuiz()
var quizId = quizId_example; // {String} The unique identifier of this quiz. This is an opaque string.
var scoreQuizAnswers = ; // {ScoreQuizAnswers} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
quizzesApi.scoreQuiz(quizId, scoreQuizAnswers, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Path parameters
Name Description
quizId*
String
The unique identifier of this quiz. This is an opaque string.
Required
Body parameters
Name Description
scoreQuizAnswers *

The identity

Responses


Verify

getContactVerification

Retrieves contact verification resource.

Retrieves the contact verification status. If the `contactUri` link is invalid a 400 Bad Request response will be returned. The following links will be included in a successful response under the _links property: * `apiture:contact`: If the specified contactUri param refers to a Contact resource a link to it will be present


/contactVerification

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/contactVerification?contactUri=&type="
import { VerifyApi } from "@apiture/identity-client-sdk";

const verifyApi = new VerifyApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
verifyApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
verifyApi.setApiKey(apiKey);


var api = new Identity.VerifyApi.getContactVerification()
var contactUri = contactUri_example; // {String} The `apiture:contact` URI.
var opts = {
  'type': type_example // {String} The identity method type. Possible values are `fraudRiskReport`, `quiz` or `adminApproval`.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
verifyApi.getContactVerification(contactUri, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/full Full access to user and contact related resources.

Parameters

Query parameters
Name Description
contactUri*
String
The `apiture:contact` URI.
Required
type
String
The identity method type. Possible values are `fraudRiskReport`, `quiz` or `adminApproval`.

Responses