Skip to main content
API docs by Redocly

One37ID - Business Connector JS Agency API (1.0)

Download OpenAPI specification:Download

Agency API for Business Connector JS

Swagger document

Connect

Recreate a URL to connect any user to the current agency.

header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": "string"
}

Get a URL to connect any user to the current agency.

header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": "string"
}

Get a QR code to connect any user to the current agency.

header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorCode": 0,
  • "message": "string"
}

Establish new connection by user did.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
did
required
string >= 16 characters
defaultAlias
required
string non-empty
title
string

Responses

Request samples

Content type
application/json
{
  • "did": "stringstringstri",
  • "defaultAlias": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Establish new connection by user/business alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
alias
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "alias": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Establish new connection by Out-Of-Band invitation url.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
url
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Establish new connection by linked domain name.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
linkedDomain
required
string non-empty
defaultAlias
required
string non-empty
title
string

Responses

Request samples

Content type
application/json
{
  • "linkedDomain": "string",
  • "defaultAlias": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Connection

Get connection details by Agent Id.

path Parameters
id
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Get connection details by Agent alias.

path Parameters
alias
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Get connection list.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
id
string
alias
string
displayName
string
withStageAccess
boolean
sortOrder
string
currentPage
required
number >= 0
rowsPerPage
required
number >= 0

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "alias": "string",
  • "displayName": "string",
  • "withStageAccess": true,
  • "sortOrder": "string",
  • "currentPage": 0,
  • "rowsPerPage": 0
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Add access to stage area for connection by agent id.

path Parameters
id
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Remove access to stage area for connection by agent id.

path Parameters
id
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Delete connection by agent id.

path Parameters
id
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Delete connections by agent id's.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
id
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Action Message

Send an action message to a user by agent id.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string [ 1 .. 64 ] characters
requestId
string non-empty
expiryDate
string <date-time>
metadata
object
required
object (ActionMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "requestId": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Send an action message to a user by alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentAlias
required
string [ 1 .. 128 ] characters
isConnectionless
boolean
Default: false
requestId
string non-empty
expiryDate
string <date-time>
metadata
object
required
object (ActionMessagePayload)

Responses

Request samples

Content type
application/json
Example

This is an example of simple action message with two buttons.

{
  • "agentAlias": "default:ap1",
  • "isConnectionless": false,
  • "metadata": {
    },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Custom Message

Send a custom message to a user by agent id.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string [ 1 .. 64 ] characters
required
object (CustomMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Send a custom message to a user by alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentAlias
required
string [ 1 .. 128 ] characters
isConnectionless
boolean
Default: false
required
object (CustomMessagePayload)

Responses

Request samples

Content type
application/json
Example

This is an example of a simple message with a couple of fields in payload.

{
  • "agentAlias": "default:ap1",
  • "isConnectionless": false,
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Data Message

Send a data message to a user by agent id.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string [ 1 .. 64 ] characters
requestId
required
string non-empty
required
object (DataMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "requestId": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Send a data message to a user by alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentAlias
required
string [ 1 .. 128 ] characters
requestId
required
string non-empty
required
object (DataMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentAlias": "string",
  • "requestId": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

General Message

Send a general message to a user by agent id.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string [ 1 .. 64 ] characters
required
object (GeneralMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Send a general message to a user by alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentAlias
required
string [ 1 .. 128 ] characters
isConnectionless
boolean
Default: false
required
object (GeneralMessagePayload)

Responses

Request samples

Content type
application/json
Example

This is an example of simple message with title and description.

{
  • "agentAlias": "default:ap1",
  • "isConnectionless": false,
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

System Message

Send a system message to a user by agent id.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string [ 1 .. 64 ] characters
required
object (SystemMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Send a system message to a user by alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentAlias
required
string [ 1 .. 128 ] characters
required
object (SystemMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentAlias": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Init Workflow Message

Initiate a workflow on other Agent by agent id.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string [ 1 .. 64 ] characters
required
object (InitWorkflowMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Initiate a workflow on other Agent by alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentAlias
required
string [ 1 .. 128 ] characters
required
object (InitWorkflowMessagePayload)

Responses

Request samples

Content type
application/json
{
  • "agentAlias": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Credential

Issue a credential to a user by agent id.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string = 36 characters
requestId
string non-empty
expiryDate
string <date-time>
required
Array of objects (IssueCredentialPayload)

Responses

Request samples

Content type
application/json
{
  • "agentId": "stringstringstringstringstringstring",
  • "requestId": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "payload": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Issue a credential to a user by alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentAlias
required
string [ 1 .. 128 ] characters
requestId
string non-empty
expiryDate
string <date-time>
required
Array of objects (IssueCredentialPayload)

Responses

Request samples

Content type
application/json
Example

This is an example of issuing a verified email W3C credential.

{
  • "agentAlias": "default:ap1",
  • "payload": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Build connectionless credential offer.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
requestId
string non-empty
expiryDate
string <date-time>
required
Array of objects (IssueCredentialPayload)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "payload": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Build connectionless credential offer as QR code image.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
requestId
string non-empty
expiryDate
string <date-time>
required
Array of objects (IssueCredentialPayload)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "payload": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorCode": 0,
  • "message": "string"
}

Get credential list.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
dateFrom
string <date-time>
dateTo
string <date-time>
sortOrder
string
currentPage
required
number >= 0
rowsPerPage
required
number >= 0

Responses

Request samples

Content type
application/json
{
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "sortOrder": "string",
  • "currentPage": 0,
  • "rowsPerPage": 0
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Get credential details.

path Parameters
id
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Delete credential.

path Parameters
id
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorCode": 0,
  • "message": "string"
}

Check is credential revoked or suspended.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
purpose
required
string
Enum: "revocation" "suspension"

Status list purpose.

id
required
string >= 36 characters

Responses

Request samples

Content type
application/json
{
  • "purpose": "revocation",
  • "id": "stringstringstringstringstringstring"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": true
}

Revoke a credential by adding it to the Revocation List.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
purpose
required
string
Enum: "revocation" "suspension"

Status list purpose.

isNotifyHolder
boolean
Default: false
id
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "purpose": "revocation",
  • "isNotifyHolder": false,
  • "id": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": 0
}

Revoke all credentials that meet specified criteria by adding them to the Revocation List.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
purpose
required
string
Enum: "revocation" "suspension"

Status list purpose.

isNotifyHolder
boolean
Default: false
schemaId
string
required
Array of objects (IssuedCredentialAttributeRequest)

Responses

Request samples

Content type
application/json
{
  • "purpose": "revocation",
  • "isNotifyHolder": false,
  • "schemaId": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": 0
}

Unrevoke a credential by removing it from the Revocation List.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
purpose
required
string
Enum: "revocation" "suspension"

Status list purpose.

isNotifyHolder
boolean
Default: false
id
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "purpose": "revocation",
  • "isNotifyHolder": false,
  • "id": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": 0
}

Restore all credentials matching specified criteria by removing them from the Revocation List.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
purpose
required
string
Enum: "revocation" "suspension"

Status list purpose.

isNotifyHolder
boolean
Default: false
schemaId
string
required
Array of objects (IssuedCredentialAttributeRequest)

Responses

Request samples

Content type
application/json
{
  • "purpose": "revocation",
  • "isNotifyHolder": false,
  • "schemaId": "string",
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": 0
}

Credential Offer

Get credential offer list.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
dateFrom
string <date-time>
dateTo
string <date-time>
sortOrder
string
currentPage
required
number >= 0
rowsPerPage
required
number >= 0

Responses

Request samples

Content type
application/json
{
  • "dateFrom": "2019-08-24T14:15:22Z",
  • "dateTo": "2019-08-24T14:15:22Z",
  • "sortOrder": "string",
  • "currentPage": 0,
  • "rowsPerPage": 0
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Get credential offer details.

path Parameters
id
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Accept credential offer.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
id
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Reject credential offer.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
id
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Delete credential offer.

path Parameters
id
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorCode": 0,
  • "message": "string"
}

Proof Request

Send proof request to a user by id.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string = 36 characters
requestId
string non-empty
protocol
string
Default: "oid4vp"
Enum: "oid4vp" "didcomm"
expiryDate
string <date-time>
metadata
object
required
object (ProofRequestPayload)

Responses

Request samples

Content type
application/json
{
  • "agentId": "stringstringstringstringstringstring",
  • "requestId": "string",
  • "protocol": "oid4vp",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Send proof request to a user by alias.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentAlias
required
string [ 1 .. 128 ] characters
requestId
string non-empty
protocol
string
Default: "oid4vp"
Enum: "oid4vp" "didcomm"
expiryDate
string <date-time>
metadata
object
required
object (ProofRequestPayload)

Responses

Request samples

Content type
application/json
Example

This is an example of presentation request of verified email as W3C credential.

{
  • "agentAlias": "default:ap1",
  • "protocol": "oid4vp",
  • "metadata": {
    },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Build connectionless proof request.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
requestId
string non-empty
protocol
string
Default: "oid4vp"
Enum: "oid4vp" "didcomm"
expiryDate
string <date-time>
metadata
object
required
object (ProofRequestPayload)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "protocol": "oid4vp",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Build connectionless proof request as QR code image.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
requestId
string non-empty
protocol
string
Default: "oid4vp"
Enum: "oid4vp" "didcomm"
expiryDate
string <date-time>
metadata
object
required
object (ProofRequestPayload)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "protocol": "oid4vp",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorCode": 0,
  • "message": "string"
}

Flow Controller

Get list of url on static flows (without expiration date).

header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": "string"
}

Get url to start flow.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
workflow
required
string non-empty
methodName
string non-empty
isConnectionRequired
boolean
expiryDate
string <date-time>
goalCode
string
goal
string
parameters
object

Responses

Request samples

Content type
application/json
{
  • "workflow": "string",
  • "methodName": "string",
  • "isConnectionRequired": true,
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "goalCode": "string",
  • "goal": "string",
  • "parameters": { }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": "string"
}

Get url as QR code image to start flow.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
workflow
required
string non-empty
methodName
string non-empty
isConnectionRequired
boolean
expiryDate
string <date-time>
goalCode
string
goal
string
parameters
object

Responses

Request samples

Content type
application/json
{
  • "workflow": "string",
  • "methodName": "string",
  • "isConnectionRequired": true,
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "goalCode": "string",
  • "goal": "string",
  • "parameters": { }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorCode": 0,
  • "message": "string"
}

BE Engine

Start new flow using embedded BE Engine.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
workflowName
required
string non-empty
workflowVersion
string
payload
object

Responses

Request samples

Content type
application/json
{
  • "workflowName": "string",
  • "workflowVersion": "string",
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Resume flow by correlation id on BE Workflow Engine.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
correlationId
required
string non-empty
payload
object

Responses

Request samples

Content type
application/json
{
  • "correlationId": "string",
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Resume specific flow on BE Workflow Engine.

path Parameters
instanceId
required
string

Flow instance identifier.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
invocationPoint
required
string
payload
object

Responses

Request samples

Content type
application/json
{
  • "invocationPoint": "string",
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Metrics - Provided by MetricsModule Library

Create a new metric event.

Request Body schema: application/json
required
Id
string
Job
required
string
MetricName
required
string
MetricValue
required
number
Unit
required
string
ContactIdentifier
string
Tag
string
Tags
Array of strings
Created
string <date-time>
Default: "2024-11-18T13:07:45.669Z"

Responses

Request samples

Content type
application/json
{
  • "Id": "string",
  • "Job": "string",
  • "MetricName": "string",
  • "MetricValue": 0,
  • "Unit": "string",
  • "ContactIdentifier": "string",
  • "Tag": "string",
  • "Tags": [
    ],
  • "Created": "2024-11-18T13:07:45.669Z"
}

ARS

Get alias value.

path Parameters
aliasKey
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": "string"
}

Get alias details.

path Parameters
aliasKey
required
string
header Parameters
hash
required
string

Secret key

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Create alias in ARS.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
agentId
required
string = 36 characters
isOverride
required
boolean
Default: false
required
object (CreateAliasPayloadRequest)

Responses

Request samples

Content type
application/json
{
  • "agentId": "stringstringstringstringstringstring",
  • "isOverride": false,
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Policy Compliance

Check credential schema compliance with privacy policy

Request Body schema: application/json
required
schemaId
required
string
privacyPolicyUrl
required
string

Responses

Request samples

Content type
application/json
{
  • "schemaId": "string",
  • "privacyPolicyUrl": "string"
}

Studio Authentication.

Sign-in to Business with alias or QR code.

Request Body schema: application/json
required
contactId
required
string = 36 characters
alias
string
sessionId
string
metadata
object

Responses

Request samples

Content type
application/json
{
  • "contactId": "stringstringstringstringstringstring",
  • "alias": "string",
  • "sessionId": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Sign-up to Business with alias or QR code.

Request Body schema: application/json
required
alias
string
metadata
object

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Complete sign-in process to Business.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
isSuccessful
required
boolean
message
string
sessionId
required
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "isSuccessful": true,
  • "message": "string",
  • "sessionId": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Complete sign-up process to Business.

header Parameters
hash
required
string

Secret key

Request Body schema: application/json
required
isSuccessful
required
boolean
message
string
agentId
required
string
signupType
required
number
Enum: 0 1 2
inviteId
string
assignedByUserId
string
required
object (BusinessSignUpCompletePayloadRequest)

Responses

Request samples

Content type
application/json
{
  • "isSuccessful": true,
  • "message": "string",
  • "agentId": "string",
  • "signupType": 0,
  • "inviteId": "string",
  • "assignedByUserId": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Alias Local Management

Check is alias is available and could be reserved.

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{ }

Get a list of aliases.

Authorizations:
studio
Request Body schema: application/json
required
id
string
displayName
string
state
Array of numbers
Items Enum: 1 2 3
sortOrder
string
currentPage
required
number >= 0
rowsPerPage
required
number >= 0

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "state": [
    ],
  • "sortOrder": "string",
  • "currentPage": 0,
  • "rowsPerPage": 0
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Start aliases syncup process with ARS.

Authorizations:
studio

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Get an Alias by ID.

Authorizations:
studio
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Create a new Alias

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters
displayName
string <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Delete an Alias.

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Set Alias State to enable.

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Set Alias State to disable.

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Alias External/Public Management.

Check is alias is available and could be reserved.

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{ }

Get a list of aliases.

Authorizations:
studio
Request Body schema: application/json
required
id
string
displayName
string
state
Array of numbers
Items Enum: 1 2 3
sortOrder
string
currentPage
required
number >= 0
rowsPerPage
required
number >= 0

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "state": [
    ],
  • "sortOrder": "string",
  • "currentPage": 0,
  • "rowsPerPage": 0
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Start aliases syncup process with ARS.

Authorizations:
studio

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Get an Alias by ID.

Authorizations:
studio
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Create a new Alias

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters
displayName
string <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Delete an Alias.

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Set Alias State to enable.

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Set Alias State to disable.

Authorizations:
studio
Request Body schema: application/json
required
id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Business Discovery Management.

Check business discoverable status.

Authorizations:
studio

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "errorCode": 0,
  • "message": "string"
}

Make business discoverable.

Authorizations:
studio

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Make business non-discoverable.

Authorizations:
studio

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Publish flows to One37 Discover service.

Authorizations:
studio

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Studio User Invite Management Using Agency.

Create new invite for user to join a Business.

Authorizations:
studio
Request Body schema: application/json
required
alias
required
string non-empty
roles
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "alias": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccessfull": true,
  • "result": {
    }
}

Studio User Management.

Sign-in to Business with alias or QR code.

Authorizations:
studio

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}

Business Profile.

Send profile to trust authortity (home agency) for signuture.

Authorizations:
studio

Responses

Response samples

Content type
application/json
{
  • "isSuccessfull": true
}
X

Graph View