Admin API

Public Functions description

Roles and Permissions

Function getPermissions()

Returns permissions of current identity

Returns:

Promise

Function getRoleList()

Gets the list of all administrator roles roles

Returns:

Promise

Function rolePermissionsList()

Gets the list of all possible permissions

Returns:

Promise

Function getRole(name)

Gets specific role information by name

Params:

Name	Type	Description
name	String	Name of the role

Returns:

Promise

Function roleCreate(name, permissions)

Gets specific role information by name

Params:

Name	Type	Description
name	String	Id of the role
permissions	String[]	List of permissions for the new role

Returns:

Promise

Function roleUpdatePermissions(name, permissions)

Updates role permissions

Params:

Name	Type	Description
name	String	Id of the role
permissions	String[]	List of new permissions

Returns:

Promise

Function roleDelete(name)

Deletes role

Params:

Name	Type	Description
name	String	Id of the role
permissions	String[]	List of permissions for the new role

Returns:

Promise

Function assignRole(name, targetIdentityId)

Assigns role to specific Identity

Params:

Name	Type	Description
name	String	Id of the role
targetIdentityId	String	an ID of the target identity

Returns:

Promise

Function unAssignRole(name, targetIdentityId)

Removes role to specific Identity

Params:

Name	Type	Description
name	String	Id of the role
targetIdentityId	String	an ID of the target identity

Returns:

Promise

Identity Profile

Function identitySearch(searchQuery, pageSize, pageNumber1)

Search for a list of identities with filters

Params:

Name	Type	Description
searchQuery	IIdentitySearchQuery	search request with filters
pageSize	Number	size of page to retrieve
pageNumber	Number	page to search, default 1


interface IIdentitySearchQuery {
  identityId?: string,
  unique?: string,
  status?: IdentityStatus,
  riskScore?: RiskScore,
  creationDateFrom?: string,
  creationDateTo?: string,
  completionDateFrom?: string,
  completionDateTo?: string,
  completionDate?: string,
  nameSurname?: string,
  residence?: string,
  email?: string,
  phone?: string,
  isAdmin?: boolean,
  documentStatus?: KYCStatus,
  addressStatus?: KYCStatus,
  amlStatus?: KYCStatus,
  emailStatus?: KYCStatus,
  roleId?: string
}

Returns:

Promise

Function getIdentityById(identityId)

Gets specific Identity by its Id

Params:

Name	Type	Description
identityId	String	an ID of the target identity

Returns:

Promise

Function getPhoneNumber(fileId)

Gets mobile phone number

Params:

Name	Type	Description
phoneId	String	an ID of phone asset

Returns:

Promise

Function getEmail(emailId)

Gets email address

Params:

Name	Type	Description
emailId	String	an ID of email asset

Returns:

Promise

Function getBioInfo(targetIdentityId)

Gets bio information from uploaded files

Params:

Name	Type	Description
targetIdentityId	String	an ID of the target identity

Returns:

Promise

Function getDocInfo(documentId, reason)

Gets document information from uploaded files

Params:

Name	Type	Description
documentId	String	an ID of the document asset
reason	String	reason for retrieving document information

Returns:

Promise

Function getAddressConfirmInfo(addressConfirmId)

Gets address confirmation info from uploaded files

Params:

Name	Type	Description
addressConfirmId	String	an ID of the address asset

Returns:

Promise

Function getVerificationInfo(documentId)

Gets document verification information

Params:

Name	Type	Description
documentId	String	an ID of the document asset

Returns:

Promise

Function getAmlInfo(identityId)

Gets the latest results of AML check of the user

Params:

Name	Type	Description
identityId	String	Identity id of specific user

Returns:

Promise

Function getAmlInfo(identityId)

Gets the latest results of AML check of the user

Params:

Name	Type	Description
identityId	String	Identity id of specific user

Returns:

Promise

Function blockIdentity(identityId, reason)

Block identity by ID (switch status from ACTIVE to BLOCKED)

Params:

Name	Type	Description
identityId	String	Identity id of specific user
reason	String	text description

Returns:

Promise

Function unblockIdentity(identityId)

Unlock identity by ID (switch status from BLOCKED to ACTIVE)

Params:

Name	Type	Description
identityId	String	Identity id of specific user

Returns:

Promise

Function editIdentityDescription(identityId, newDescription)

edit identity description field (old description must be included)

Params:

Name	Type	Description
identityId	String	Identity id of specific user
newDescription	String	New identity description

Returns:

Promise

Recovery Requests

Function recoveryRequestSearch(searchQuery, pageSize, pageNumber)

Search for a list of recovery requests with filters

Params:

Name	Type	Description
searchQuery	IRecoveryRequestSearchQuery	search request with filters
pageSize	Number	Size of page to retrieve
pageNumber	Number	Page to search, default 1


interface IRecoveryRequestSearchQuery {
  status: RecoveryRequestStatus
}

Returns:

Promise

Function recoveryRequestGetById(id, enrollmentId)

Gets recovery request by composite key of id and enrollmentId

Params:

Name	Type	Description
identityId	String	Identity id of specific user
enrollmentId	String	EnrollmentId of the sender of the request

Returns:

Promise

Function recoveryRequestApprove(id, enrollmentId)

Approves recovery request. Requesting Device will be attached to Identity and receive access to it.

Params:

Name	Type	Description
identityId	String	Identity id of specific user
enrollmentId	String	EnrollmentId of the sender of the request

Returns:

Promise

Function recoveryRequestReject(id, enrollmentId)

Rejects recovery request.

Params:

Name	Type	Description
identityId	String	Identity id of specific user
enrollmentId	String	EnrollmentId of the sender of the request

Returns:

Promise