Documentation Powered by ReDoc

NAO Orchestrator (1.0.0)

Download OpenAPI specification:Download

Authentication

Bearer

Authentication JWT token, prefixed by Bearer: Bearer ${JWT}

Security Scheme Type API Key
Header parameter name: Authorization

NewAccountOpeningService

New Account Opening

New Account Opening Request

Authorizations:
Bearer
Request Body schema: application/json
clientId
required
string (clientId) ^[a-zA-Z0-9]{1,64}$

Kount's unique identifier for a Client

deviceSessionId
required
string (deviceSessionId) ^[\w-]{0,32}$

Device collection event identifier

userIp
string <ipv4> (userIp)

User’s IPv4 address as identified by the Client

newAccountOpeningUrl
string (newAccountOpeningUrl) ^.{0,256}$

Webpage from which a Client’s user is attempting open a new account

object (v2Person)
object (v2Account)
object (v2Strategy)
customFields
object (customFields)

A JSON object containing user-defined key-value pairs. The key is the Custom field name (max characters 256) defined within the Kount 360 portal. A value assigned to the custom field. The value must conform to the data type specified in Kount 360 portal for the corresponding custom field name. The supported data type are boolean, number and string (max characters 256).

Responses

Request samples

Content type
application/json
{
  • "clientId": "900900",
  • "deviceSessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "userIp": "192.168.0.1",
  • "newAccountOpeningUrl": "http://www.example.com/create-account",
  • "person": {
    },
  • "account": {
    },
  • "strategy": {},
  • "customFields": { }
}

Response samples

Content type
application/json
{
  • "decision": "ALLOW",
  • "deviceSessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "userProfile": "VIP",
  • "deviceId": "7363b8ae6b2247b99f5d56fc81102254",
  • "tags": [
    ],
  • "userSegment": "VIP",
  • "guidance": "ALLOW",
  • "verification": {
    },
  • "set": {
    },
  • "tagWeights": [
    ],
  • "parentOrganizationData": {
    }
}

New Account Opening Request V2

Authorizations:
Bearer
Request Body schema: application/json
inquiryId
required
string (inquiryId)

Customer supplied identifier used to track state across the “inquiry” or customer journey

channel
string (channel)

Unique identifier of the website or app and/or product where the inquiry originated

deviceSessionId
required
string (deviceSessionId) ^[\w-]{0,32}$

Unique identifier for the customer's end-user's session on the site/app. Must be the same session ID used in the device data collection from the client-side Kount SDK. Uniqueness for this property is not enforced, but customers should provide unique values.

userIp
string <ipv4> (userIp)

The customer 's end-user's IPv4 address as identified by the customer.

accountCreationUrl
string (accountCreationUrl) ^.{0,256}$

Webpage from which a Client’s user is attempting to create a new account.

object (v2Person)
object (v2AccountV2)
object (v2StrategyV2)
customFields
object (customFields)

A JSON object containing user-defined key-value pairs. The key is the Custom field name (max characters 256) defined within the Kount 360 portal. A value assigned to the custom field. The value must conform to the data type specified in Kount 360 portal for the corresponding custom field name. The supported data type are boolean, number and string (max characters 256).

Responses

Request samples

Content type
application/json
{
  • "inquiryId": "string",
  • "channel": "ACME_IOS_APP",
  • "deviceSessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "userIp": "192.168.0.1",
  • "accountCreationUrl": "http://www.example.com/create-account",
  • "person": {
    },
  • "account": {
    },
  • "strategy": {
    },
  • "customFields": { }
}

Response samples

Content type
application/json
{
  • "decision": "ALLOW",
  • "deviceSessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "deviceId": "7363b8ae6b2247b99f5d56fc81102254",
  • "policyManagement": {
    },
  • "verification": {
    },
  • "parentOrganizationData": {
    }
}