Skip to main content
API docs by Redocly

Aggregate API (1.0.0)

Download OpenAPI specification:Download

Aggregate API specification

Aggregate API

Account Create

API for the account create and triggering workflow. Authentication for these APIs will remain same as current authentication for Account Initiate and Account Update API .

header Parameters
User-Agent
required
string
Authorization
required
string

OTP token which has been received on the account create / update

Request Body schema: multipart/form-data
required
initiate
string

Json String of AccountRequest. Example - customerInternalReference, callbackUrl, workflowDefinition, userReference, tokenLifetime.

prepared-data
string, or null

Json String of PreparedData. Example - firstName, lastName, middleName, dateOfBirth, phoneNumber, socialSecurityNumber, ipAddress, address.

Responses

Response samples

Content type
application/json
{
  • "workflow": {
    },
  • "account": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "wipedOutAt": "2019-08-24T14:15:22Z",
  • "credentials": [
    ],
  • "decision": {
    },
  • "steps": {},
  • "capabilities": {
    },
  • "rules": {
    }
}

Account Update

API for the account update and triggering workflow. Authentication for these APIs will remain same as current authentication for Account Initiate and Account Update API

path Parameters
accountId
required
string <uuid>
header Parameters
User-Agent
required
string
Request Body schema: multipart/form-data
required
initiate
string

Json String of Account Request. Example - customerInternalReference, callbackUrl, workflowDefinition, userReference, tokenLifetime.

prepared-data
string

Json String of Prepared Data. Example - firstName, lastName, middleName, dateOfBirth, phoneNumber, socialSecurityNumber, ipAddress, address.

Responses

Response samples

Content type
application/json
{
  • "workflow": {
    },
  • "account": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "wipedOutAt": "2019-08-24T14:15:22Z",
  • "credentials": [
    ],
  • "decision": {
    },
  • "steps": {},
  • "capabilities": {
    },
  • "rules": {
    }
}