Access

Represents an access a user has to a group of applications. With this access, the user can work with transactions within those applications. An access can be one of two different types: PRIVATE or CORPORATE.

Name	Description	Qualification	Schema

Name	Description	Qualification	Schema
accessId	The ID of the access. It must not be specified during creation as it is generated by the server, but is required when updating an access.	Required Read-only	string
corporateId	The ID of the corporate role account. Required if the access type is CORPORATE. Not allowed if the access type is PRIVATE. Note that corporateId refers to the ID of the external or internal role account. This cannot be changed after the access has been created.	Optional Read-only	string
corporateName	The name of the company for which the user acts when working with this access. Only applicable if the access type is CORPORATE.	Optional	string
corporateRoleName	The name of the corporate role the user acts in when working with this access. Only applicable if the access type is CORPORATE.	Optional	string
firstName	The first name of the user that this access belongs to.	Required	string
lastName	The last name of the user that this access belongs to.	Required	string
managed	This parameter must be set to true for the access to work as intended, and indicates that it is activated and operated by the platform on behalf of the user. For example, when an application requests the access to sign a transaction, the platform signs the transaction on behalf of the user. This cannot be changed after the access has been created	Required Read-only	boolean
privateId	The ID of the personal identity that this access is linked to.	Required Read-only	string
state	The state of the access. It can be specified during creation, but the only valid values for a platform-managed access are INVITED and ACTIVE. If a platform-managed access is created with the state INVITED, it is up to the application to activate the access before it is ready for use. If a platform-managed access is created and the state is not specified, it gets the status ACTIVE. The state of an access can be changed via the 'Update access' API. INVITED: The access has been created but not yet activated by the application. It cannot be used until the application has activated it. ACTIVE: The access has been activated by the application and can be used. DEACTIVATED: The access has been disabled and cannot be used.	Required	enum (INVITED, ACTIVE, DEACTIVATED)
type	Specifies whether the user that the access is given to acts in their private role or in a corporate role. PRIVATE: The user acts as in their private role. CORPORATE: The user acts in a corporate role.	Required Read-only	enum (PRIVATE, CORPORATE)