API Reference

Approval Groups

Create approval group

Get approver groups

Get approval group by id

Requests

Create request

Get requests

Cosigner API

The "Create request" functionality of the Cosigner API primarily serves to initiate and manage requests for approvals within an organization. This is especially useful in various scenarios requiring multiple checks and balances, decisions by committees, or approval processes involving different departments or teams.

By calling this API endpoint, you can create a request that specifies a title and a description, which provide essential information about the request. The minimum number of approvers can be set to ensure that the request is adequately reviewed before being accepted or denied.

Adding to the flexibility of the process, the "Create request" feature allows you to provide a notification URL. This URL is used to send notifications about the status of the request, keeping the relevant individuals or systems updated.

The feature also includes a unique aspect - 'metadata'. This allows you to include any additional data related to the request, which might not fit into the standard parameters but are vital for your specific application or use-case.

You can also specify an 'approverGroupId', which is a way to group approvers if your organization has specific teams or departments handling different requests.

Upon successful creation of the request, the API returns a response that includes multiple information about the request, including its unique identifier, the organization it belongs to, and the initial status of the request. Importantly, the response indicates whether the request has been approved or denied, and by how many, providing a clear picture of the request's progress.

In summary, the "Create request" functionality of the Cosigner API opens up new avenues for managing multi-level approvals in an organized, efficient, and customizable manner.

The title of the request to be created. It should be a concise and clear representation of the request's purpose.

title

A detailed description of the request. This should provide more context than the title.

description

The minimum number of approvals required for the request to be considered approved.

minApprovers

The URL to which notifications related to the request will be sent. This must be a valid URL that can handle POST requests.

notificationUrl

Additional data associated with the request. This field accepts a JSON object.

metadata

The identifier of the group that will approve the request. This should correspond to a valid group within your organization.

approverGroupId

The API key provided in the header for authentication. This should correspond to your organization's unique API key.

x-api-key

A unique identifier for the request. This is a read-only field provided in the response.

The identifier for the organization associated with the request. This is a read-only field provided in the response.

organizationId

The current status of the request. This is a read-only field provided in the response.

status

A flag indicating whether the request has been approved. This is a read-only field provided in the response.

hasApproved

A flag indicating whether the request has been denied. This is a read-only field provided in the response.

hasDenied

The timestamp when the request was created. This is a read-only field provided in the response.

createdAt

The number of approvers who have approved the request. This is a read-only field provided in the response.

numApproved

Unauthorized

Unprocessable Entity

The Cosigner API's 'get /api/requests' endpoint serves a crucial role in the process of retrieving information regarding different requests submitted within your organization. Perfect for a variety of use cases, this endpoint allows you to systematically understand, track, and manage the status and details of these requests.

One of the primary features of this endpoint is its ability to retrieve a comprehensive set of data associated with each request. This set includes not only basic information such as the request's id, title, and description but also more complex attributes. For example, it can provide details about the minimum number of approvers required (minApprovers), the approver group id (approverGroupId), and a collection of additional data (metadata).

On a broader scale, this endpoint can be instrumental in getting updates about the state of each request. It provides the status of the request, along with data about whether it has been approved or denied and by how many (hasApproved, hasDenied, numApproved). This is coupled with the date and time the request was created (createdAt), offering a complete snapshot of the process.

For a more interactive experience, this endpoint also returns the URL (notificationUrl) where notifications related to the request are sent. This allows you to directly navigate to the relevant notifications page for real-time updates.

However, please note that this endpoint requires an API key for authorization. This ensures secure access to sensitive data and helps maintain the integrity of your organization's information.

In summary, the 'get /api/requests' endpoint is a versatile tool for pulling request data, tracking their progression, and interacting with related notifications. Its broad range of returned parameters makes it adaptable to various organizational needs, ensuring a seamless integration with your existing systems.

The unique API key used for authenticating the request.

page

limit

needsDecision

email

The unique identifier assigned to the request.

The identifier for the organization making the request.

The title of the request made for a co-signer.

A brief description outlining the purpose of the request.

The URL where notifications regarding the request are sent.

Any additional data associated with the request.

The identifier for the group of users who are granted the authority to approve the request.

The current status of the request, such as 'pending', 'approved', or 'denied'.

A boolean parameter that indicates whether the request has been approved.

A boolean parameter that indicates whether the request has been denied.

The timestamp indicating when the request was initially created.

The number of approvals that the request has received.

Sections