Get Documentation for a List of Controllers.

Get Documentation for a Controller.

Get Documentation for a Method.

Get Documentation for a Type.

Returns the HTML Documentation home page.

Get HTML Documentation for a Controller.

Get HTML Documentation for a Method.

Get HTML Documentation for a Type.

Refresh Access token using current Refresh token.

Return the value as an integer for the current user (or zero for non-authenticated requests).

Destroy Bearer tokens for the currently authenticated user.

Initiate Email Authentication (MFA) for the currently authenticated user.

Complete Email Authentication (MFA) for the currently authenticated user.

Attempt to authenticate and receive Access and Refresh Bearer tokens.

Initiate Password change request by email.

Complete Password change request using code sent by email.

Create a new Client account for this User.

Called by Portal Frontend to register a new User/Client combination i.e. new customer registration.

Confirm Email Authentication on Client Sign up. Marks Email as Confirmed (previously done in Mfa Auth process). Sends Client import and notification of new Client Sign up.

Gets a table of ISO-3166 Countries.

Gets a table of Currencies.

Gets a table of supported Telephone Systems (numbering systems).

Get the Client IP Address

Gets a Debtor by debtorId. Debtor must be child of supplied clientId. User must have access to Client hierarchy.

Called by Portal Frontend to add a Debtor to a Client account.

Get a Draft Debtor for a Client account.

Called by Portal Frontend to add a Debtor to a Client account using Client account and Draft Debtor.

Default redirect to HTML documentation.

Responds with JSON Status of API. Useful for service monitoring.

Responds with Success. Useful for service monitoring.

Allows automated unsubscribe of known email addresses. Uses the EmailAddressList.Id to prevent Unsubscribe storms. No need for List Name due to Id use. We require the Email Address to prevent random or sequential Guid attempts.

Handle uploaded files for a Debtor record. Files are added to the Proclaim Sync Queue with the Debtor as a pre-dependency.

Used to Create a new top-level (Corporate) Client User. Used by Portal Signup process for Clients.

Invite an additional User to join the Client account

Re-Invite an addiitional User to join the Client account.

Allows a Client User to update their User record.

Get the currently signed-in User record.

Get the User account by Id. Can only get a Client User account you have access to. Used by Client User accounts that have multiple Client User accounts.

Update Email / Password for a Client User account.

Used for CRM-led client account creation. This method allows the new User to set a password and signin. Confirmation code is provided by email prior to call, so no need for a second visual auth step.

User for CRM-led client account creation. Checks if the Client User has completed setup.

Used for invite-led user account creation. This method allows the new User to set a password and signin. Confirmation code is provided by email prior to call, so no need for a second visual auth step.