Corporate Identity Paylet

What is a Corporate Identity?

A Corporate Identity represents a business entity, a corporate, that is administered through a number of related users that are assigned appropriate rights by a root user. In a Payment Model, a Corporate Identity Paylet is generally related to Instrument Paylets (e.g. to represent a Corporate owning External Bank Account, Managed Accounts and Virtual Cards). Additional API methods related to logging in as a Corporate Identity can be found in the Authentication page. Refer to the Corporates Swagger documentation for the complete list of APIs that may be invoked in relation to Corporate Identities.

Corporate Identity Paylet API

URL Method Description
/corporates/get POST Retrieve a list of the Corporate Identity instances
/corporates/{id}/get POST Retrieve the detail of the Corporate Identity with the specified ID
/corporates/_/create POST Create a new instance of a Corporate Identity according to a specified Profile. Note that you will need to call method /passwords/{credential_id}/create to create the password for the corporate identity root user.
/corporates/profiles/get POST Retrieve a list of Profiles that can be used to create a Corporate Identity
/corporates/profiles/{id}/get POST Retrieve the detail of the Profile specified in the request
/corporates/users/get POST Retrieve a list of Users of a Corporate Identity
/corporates/users/{id}/get POST Retrieve the detail of the User specified in the request

Corporate Identity Instance Attributes

Attribute Description
Id The id assigned to the Corporate Identity
Name The name of the Corporate Identity
Profile ID The ID of the Profile that was used to create the Identity
Profile Name The name of the Profile that was used to create the Identity
Support Email The email address used by the system to notify and receive system support messages
Notification Email The email address used to receive product related notifications
State Indicates if the identity is active or not
Creation Timestamp The date and time the Corporate Identity instance was created