Role Permissions

Below are the possible roles you may be assigned for a set of credentials. The table lists the method(s) you have access to and a link to their schema description.

You can view the roles assigned to you by calling the GetAdministrativeUserRoles API endpoint. The names in the response will correspond with the Method Name column under each role description. You can run the same operation for individual customers by calling the GetCustomerRoles API endpoint.

info

Note that the role names are subject to change over time and shouldn't be considered static.

Legend
Technical Customer Management Actions
Applied Customer Entities Management Actions
Transaction/Operation Actions

Administrator

Allowed actions
Read Customer Attributes
Manage Accounts and related entities (policies, preregistrations)
Create Accounts
Read Accounts
Manage Bio Credentials
Create Bio Credentials
Read Bio Credentials
Manage Custom Operations and Operations Resources
Read Transaction/Operation history
Read System Audit
Perform Transaction
Read Operation Results

Available API Methods

Method Name	Swagger Link
CustomerVerifyIDDocument	VerifyIDDocument
CustomerDeleteSingleAccountBiometricCredentialRawData	DeleteSingleAccountBiometricCredentialRawData
CustomerGetAccountBiometricCredentialRawDataCount	GetAccountBiometricCredentialRawDataCount
CustomerDeleteAllAccountBiometricCredentialRawData	DeleteAllAccountBiometricCredentialRawData
CustomerCheckLiveness	CheckLiveness
CustomerCreateAccount	CreateAccount
CustomerReadAccount	GetAccount
CustomerSearchAccounts	GetAccountList
CustomerUpdateAccount	UpdateAccount
CustomerDeleteAccount	DeleteAccount
CustomerAuditAccount	GetAccountByUIN
CustomerLinkAccount	CreateAccountExternalLink
CustomerReadAccountPolicy	GetPolicy
CustomerUpdateAccountPolicy	UpdatePolicy
CustomerCreatePreRegistration	CreatePreRegistration
CustomerReadPreRegistration	GetPreRegistration
CustomerAuditPreRegistration	GetPreRegistrationsByUIN
CustomerCancelPreRegistration	CancelPreRegistration
CustomerSearchTransactions	GetTransactionList
CustomerSyncToExternalSystem	SyncToExternalSystem
CustomerSyncFromExternalSystem	SyncFromExternalSystem
CustomerCreateAccountBiometricCredential	CreateAccountBiometricCredential
CustomerReadAccountBiometricCredential	GetAccountBiometricCredential
CustomerDeleteAccountBiometricCredential	DeleteAccountBiometricCredential
CustomerVerifyAccountBiometricCredential	VerifyAccountBiometricCredential
CustomerAuditBiometricCredential	GetBiometricCredentialByExternalId
CustomerReadAccountBiometricCredentialMetadata	GetAccountBiometricCredentialsMetadata
CustomerAuditApiKey	GetApiKeyByExernalId
CustomerCreateCustomOperation	CreateCustomOperation
CustomerReadCustomOperation	GetCustomOperation
CustomerUpdateCustomOperation	UpdateCustomOperation
CustomerDeleteCustomOperation	DeleteCustomOperation
CustomerAuditCustomOperation	GetCustomOperationByExternalId
CustomerCreateCustomOperationResource	CreateCustomOperationResource
CustomerReadCustomOperationResource	GetCustomOperationResource
CustomerUpdateCustomOperationResource	UpdateCustomOperationResource
CustomerDeleteCustomOperationResource	DeleteCustomOperationResource
CustomerAuditCustomOperationResource	GetCustomOperationResourceByExternalId
CustomerReadPredefinedOperation	GetPredefinedOperations
CustomerAuditPredefinedOperation	GetPredefinedOperationByExternalId
CustomerCreatePredefinedOperationResource	CreatePredefinedOperationResource
CustomerReadPredefinedOperationResource	GetPredefinedOperationResource
CustomerUpdatePredefinedOperationResource	UpdatePredefinedOperationResource
CustomerDeletePredefinedOperationResource	DeletePredefinedOperationResource
CustomerAuditPredefinedOperationResource	GetPredefinedOperationResourceByExternalId
CustomerReadIDDocumentTypes	GetIDDocumentTypes
CustomerReadSearchMetadata	GetSearchMetadata
CustomerSearchAudit	GetSystemAuditEvents
CustomerAuditCustomerAttribute	GetCustomerAttributeByExternalId
CustomerSearchOperations	GetOperationList
CustomerReadTransactionConfirmations	GetCustomerTransactionConfirmation
CustomerAuditAdministrativeUser	GetAdministrativeUserByExternalId
CustomerReadCustomerAttribute	GetCustomerAttributes

Transactor

Allowed actions
Perform Transaction
Read Transaction Results

Available API Methods

Method Name	Swagger Link
CustomerBeginAuthorization	BeginAuthorization
CustomerBeginCustomAuthorization	BeginCustomAuthorization
CustomerEndAuthorization	EndAuthorization
CustomerAuthorizeTransaction	AuthorizeTransaction
CustomerCheckAuthorization	CheckAuthorization
CustomerCheckCustomAuthorization	CheckCustomAuthorization
CustomerSendInformationalNotification	SendInformationalNotification
CustomerCheckInformationalNotification	CheckInformationalNotification
CustomerBeginForeignAuthorization	BeginForeignAuthorization

Biometric Credentials Reader

Allowed actions
Read Bio Credentials

Available API Methods

Method Name	Swagger Link
CustomerReadAccountBiometricCredential	GetAccountBiometricCredential
CustomerReadAccountBiometricCredentialMetadata	GetAccountBiometricCredentialsMetadata
CustomerReadBiometricCredential	GetBiometricCredential

External Verificator

Allowed actions
Perform external doc verification

Available API Methods

Method Name	Swagger Link
CustomerExternalVerifyIDDocument	ExternalVerifyIDDocument

Foreign API Integrator

Allowed actions
Foreign user: confirm transaction and operation, verify docs

Available API Methods

Method Name	Swagger Link
CustomerForeignGetOperation	todo
CustomerForeignConfirmGetIdDocument	todo
CustomerForeignVerifyIdDocument	todo
CustomerForeignGetTransaction	todo
CustomerForeignConfirmTransaction	todo
CustomerForeignCheckBiometricCredential	todo
CustomerForeignConfirmGetBiometry	todo
CustomerForeignVerifyBiometry	todo

Configurator

Allowed actions
Manage Customer Settings
Manage Customer Attributes
Read Customer Attributes

Available API Methods

Method Name	Swagger Link
CustomerReadCustomerGenericSettings	GetCustomerGenericSettings
CustomerUpdateCustomerGenericSettings	UpdateCustomerGenericSettings
CustomerReadCustomerWebhookSettings	GetCustomerWebhookSettings
CustomerUpdateCustomerWebhookSettings	UpdateCustomerWebhookSettings
CustomerResetCustomerWebhookSecret	ResetCustomerWebhookSecret
CustomerCallTestWebhook	TestCustomerWebhook
CustomerCreateCustomerAttribute	CreateCustomerAttribute
CustomerReadCustomerAttribute	GetCustomerAttributes
CustomerUpdateCustomerAttribute	UpdateCustomerAttribute
CustomerDeleteCustomerAttribute	DeleteCustomerAttribute

Site Operator

Allowed actions
Manage Accounts and related entities (policies, preregistrations)
Create Accounts
Read Accounts
Manage Bio Credentials
Create Bio Credentials
Read Bio Credentials
Manage Custom Operations and Operations Resources
Read Transaction/Operation history
Read System Audit
Read Operation Results

Available API Methods

Method Name	Swagger Link
CustomerAuditAdministrativeUser	GetAdministrativeUserByExternalId
CustomerCreateAccount	CreateAccount
CustomerReadAccount	GetAccount
CustomerSearchAccounts	GetAccountList
CustomerUpdateAccount	UpdateAccount
CustomerDeleteAccount	DeleteAccount
CustomerAuditAccount	GetAccountByUIN
CustomerLinkAccount	CreateAccountExternalLink
CustomerReadAccountPolicy	GetPolicy
CustomerUpdateAccountPolicy	UpdatePolicy
CustomerCreatePreRegistration	CreatePreRegistration
CustomerReadPreRegistration	GetPreRegistration
CustomerAuditPreRegistration	GetPreRegistrationsByUIN
CustomerCancelPreRegistration	CancelPreRegistration
CustomerSearchTransactions	GetTransactionList
CustomerSyncToExternalSystem	SyncToExternalSystem
CustomerSyncFromExternalSystem	SyncFromExternalSystem
CustomerCreateAccountBiometricCredential	CreateAccountBiometricCredential
CustomerReadAccountBiometricCredential	GetAccountBiometricCredential
CustomerDeleteAccountBiometricCredential	DeleteAccountBiometricCredential
CustomerVerifyAccountBiometricCredential	VerifyAccountBiometricCredential
CustomerAuditBiometricCredential	GetBiometricCredentialByExternalId
CustomerReadAccountBiometricCredentialMetadata	GetAccountBiometricCredentialsMetadata
CustomerDeleteSingleAccountBiometricCredentialRawData	DeleteSingleAccountBiometricCredentialRawData
CustomerGetAccountBiometricCredentialRawDataCount	GetAccountBiometricCredentialRawDataCount
CustomerAuditApiKey	GetApiKeyByExernalId
CustomerCreateCustomOperation	CreateCustomOperation
CustomerReadCustomOperation	GetCustomOperation
CustomerUpdateCustomOperation	UpdateCustomOperation
CustomerDeleteCustomOperation	DeleteCustomOperation
CustomerAuditCustomOperation	GetCustomOperationByExternalId
CustomerCreateCustomOperationResource	CreateCustomOperationResource
CustomerReadCustomOperationResource	GetCustomOperationResource
CustomerUpdateCustomOperationResource	UpdateCustomOperationResource
CustomerDeleteCustomOperationResource	DeleteCustomOperationResource
CustomerAuditCustomOperationResource	GetCustomOperationResourceByExternalId
CustomerReadPredefinedOperation	GetPredefinedOperations
CustomerAuditPredefinedOperation	GetPredefinedOperationByExternalId
CustomerCreatePredefinedOperationResource	CreatePredefinedOperationResource
CustomerReadPredefinedOperationResource	GetPredefinedOperationResource
CustomerUpdatePredefinedOperationResource	UpdatePredefinedOperationResource
CustomerDeletePredefinedOperationResource	DeletePredefinedOperationResource
CustomerAuditPredefinedOperationResource	GetPredefinedOperationResourceByExternalId
CustomerReadIDDocumentTypes	GetIDDocumentTypes
CustomerReadSearchMetadata	GetSearchMetadata
CustomerSearchAudit	GetSystemAuditEvents
CustomerReadCustomerAttribute	GetCustomerAttributes
CustomerAuditCustomerAttribute	GetCustomerAttributeByExternalId
CustomerSearchOperations	GetOperationList
CustomerReadTransactionConfirmations	GetCustomerTransactionConfirmation
CustomerVerifyIDDocument	VerifyIDDocument
CustomerDeleteAllAccountBiometricCredentialRawData	DeleteAllAccountBiometricCredentialRawData
CustomerCheckLiveness	CheckLiveness

Transaction Result Auditor

Allowed actions
Read Transaction Results
Read Operation Results

Available API Methods

Method Name	Swagger Link
CustomerReadBiometryVerificationResult	todo
CustomerEndAuthorization	EndAuthorization
CustomerReadTransactionConfirmations	GetCustomerTransactionConfirmation
CustomerReadExternalOperationStatus	todo
CustomerReadForeignOperationStatus	todo
CustomerReadIDDocumentVerificationResult	todo

Customer Owner

Allowed actions
Manage Admin Users and API Keys
Manage Self API Keys
Manage Customer Settings
Manage Customer Attributes
Read Customer Attributes

Available API Methods

Method Name	Swagger Link
CustomerCreateAdministrativeUser	CreateAdministrativeUser
CustomerUpdateAdministrativeUser	UpdateAdministrativeUser
CustomerDeleteAdministrativeUser	DeleteAdministrativeUser
CustomerReadAdministrativeUser	GetAdministrativeUser
CustomerSearchAdministrativeUsers	GetAdministrativeUserList
CustomerReadCustomerRole	GetCustomerRoles
CustomerReadAdministrativeUserRole	GetAdministrativeUserRoles
CustomerReadCustomerGenericSettings	GetCustomerGenericSettings
CustomerUpdateCustomerGenericSettings	UpdateCustomerGenericSettings
CustomerReadCustomerWebhookSettings	GetCustomerWebhookSettings
CustomerUpdateCustomerWebhookSettings	UpdateCustomerWebhookSettings
CustomerResetCustomerWebhookSecret	ResetCustomerWebhookSecret
CustomerCallTestWebhook	TestCustomerWebhook
CustomerCreateCustomerAttribute	CreateCustomerAttribute
CustomerReadCustomerAttribute	GetCustomerAttributes
CustomerUpdateCustomerAttribute	UpdateCustomerAttribute
CustomerDeleteCustomerAttribute	DeleteCustomerAttribute
CustomerRevokeApiKeyRefreshTokens	RevokeApiKeyRefreshToken
CustomerRevokeCustomerRefreshTokens	RevokeCustomerRefreshToken
CustomerCreateApiKey	CreateApiKey
CustomerReadApiKey	GetApiKeys
CustomerUpdateApiKey	Deprecated, use create and delete actions
CustomerDeleteApiKey	DeleteApiKey
CustomerCreateUserApiKey	CreateUserApiKey
CustomerReadUserApiKey	GetUserApiKeys
CustomerUpdateUserApiKey	Deprecated, use create and delete actions
CustomerDeleteUserApiKey	DeleteUserApiKey
CustomerChangeAdministrativeUserPassword	ChangeAdministrativeUserPassword

API Key Manager

Allowed actions
Manage Self API Keys

Available API Methods

Method Name	Swagger Link
CustomerCreateApiKey	CreateApiKey
CustomerReadApiKey	GetApiKeys
CustomerUpdateApiKey	Deprecated, use create and delete actions
CustomerDeleteApiKey	DeleteApiKey
CustomerRevokeApiKeyRefreshTokens	RevokeApiKeyRefreshToken

GetIDDocument Transactor

Allowed actions
Perform GetIDDocument Operation
Read Operation Results
Cancel operation

Available API Methods

Method Name	Swagger Link
CustomerCreateExternalOperationDocumentRequest	todo
CustomerReadExternalOperationStatus	todo
CustomerReadIDDocumentVerificationResult	todo
CustomerCreateForeignOperationDocumentRequest	todo
CustomerReadForeignOperationStatus	todo
CustomerCancelOperation	CancelOperation

GetBiometry Transactor

Allowed actions
Perform GetBiometry Operation
Read Operation Results
Cancel operation

Available API Methods

Method Name	Swagger Link
CustomerReadBiometryVerificationResult	todo
CustomerCreateForeignOperationBiometryRequest	todo
CustomerReadForeignOperationBiometryStatus	todo
CustomerCancelOperation	CancelOperation

Auth0 Integrator

Allowed actions
Manage Self API Keys
Manage Accounts and related entities (policies, preregistrations)
Create Accounts
Read Accounts
Create Bio Credentials
Read Bio Credentials
Perform Transaction
Perform GetBiometry Operation
Perform GetIDDocument Operation
Read Operation Results

Available API Methods

Method Name	Swagger Link
CustomerCreateAccount	CreateAccount
CustomerReadAccount	GetAccount
CustomerReadAccountBiometricCredential	GetAccountBiometricCredential
CustomerCreateForeignOperationBiometryRequest	todo
CustomerReadForeignOperationBiometryStatus	todo
CustomerCreateAccountBiometricCredential	CreateAccountBiometricCredential
CustomerBeginForeignAuthorization	BeginForeignAuthorization
CustomerEndAuthorization	EndAuthorization
CustomerCreateApiKey	CreateApiKey
CustomerReadApiKey	GetApiKeys
CustomerUpdateApiKey	Deprecated, use create and delete actions
CustomerDeleteApiKey	DeleteApiKey
CustomerRevokeApiKeyRefreshTokens	RevokeApiKeyRefreshToken