API Reference

Approval Groups

Create approval group

Get approver groups

Get approval group by id

Requests

Create request

Get requests

Cosigner API

The Cosigner API's 'Create approval group' functionality is designed to streamline the process of establishing a group of individuals who can collectively approve cosigning requests. This is particularly beneficial for organizations that require multiple stakeholders to authenticate or cosign documents, thereby reinforcing checks and balances within a system.

By executing a call to the 'Create approval group' endpoint, you can instantiate a new approval group in your system. This involves providing a unique name for the group and a set of email addresses corresponding to the individuals who are to be included in this group.

Once the call is made, the API will generate a unique 'id' for the newly created group and also record the timestamp of when the group was created. This information will be included in the response, along with the provided name and the list of emails. 

This feature is not just a tool for creating new groups but also acts as a means of cataloging and managing your approval hierarchy. It offers a clear and easily accessible way to keep track of who is involved in the approval process, which can be particularly useful for auditing purposes or when you need to add or remove individuals from a group.

A unique feature of the 'Create approval group' function is that it allows the inclusion of countless email addresses within a single group. This flexibility caters to businesses of all sizes, from small startups to large corporations, providing them with a scalable solution for managing their approval processes. 

Please remember to maintain the confidentiality of the 'x-api-key' as it is required for accessing the API endpoint, and misuse can lead to unauthorized access.

This body parameter denotes the name of the approval group. It is a string that acts as a descriptor for the approval group.

name

This is a body parameter that takes in an array of email addresses. Each email in this array corresponds to a member of the approval group.

emails

This is a header parameter that is used for authorizing the API request. It should contain the API key provided to your application.

x-api-key

This response parameter is the unique identifier of the approval group, generated by the system upon creation of the approval group.

This is a response parameter that indicates the date and time when the approval group was created. It is returned in ISO 8601 date and time format.

createdAt

Successful creation of the approval group

Unauthorized

Unprocessable Entity

The Cosigner API's 'Get approver groups' endpoint is designed to streamline the process of obtaining information about specific approver groups within your organization. This functionality is primarily targeted towards applications or systems that require details about these groups for decision-making, analytics, or reporting purposes.

In essence, using this endpoint will return comprehensive details about each approver group, making it a valuable resource when you need to understand the composition and structure of your decision-making entities. The information returned includes the unique identifier (`id`), the formal name (`name`), the list of email addresses associated with that group (`emails`), and the timestamp indicating when the group was created (`createdAt`).

Whether you're developing an application to visualize the hierarchy of decision-making within your company, aligning tasks to specific approver groups, or simply keeping a track of approver groups for auditing purposes, this endpoint serves as a reliable source for obtaining accurate, real-time data.

Remember that the 'Get approver groups' endpoint delivers the most value when integrated with other endpoints in the Cosigner API. For example, after retrieving the approver groups, you may want to use other endpoints to map tasks to these groups or check the status of tasks assigned to them.

One important consideration while working with this endpoint is to ensure the security of your data. As the endpoint requires an x-api-key in the request header, be sure to safely store and handle this key to prevent unauthorized access to your information.

In conclusion, the 'Get approver groups' endpoint is a powerful tool that can provide a comprehensive view of your approver groups, thus aiding in informed decision-making and effective management of tasks within your organization.

This is a header parameter used for authenticating requests made to the API. It is a unique key assigned to each user or application making a request to the API.

page

limit

This is the unique identifier assigned to each approver group in the system. It is a string of alphanumeric characters.

This is the name assigned to the approver group. It provides a human-readable identifier for each group.

This parameter contains an array of all the email addresses associated with the approver group members.

This is a timestamp indicating the time when the approver group was created. The format used is ISO 8601.

No approver groups found

The Cosigner API's 'Get Approval Group by ID' function provides an effective way to retrieve information related to a specific approval group within our system. The approval group information is essential for various workflows, enabling necessary individuals or departments to review or approve specific actions in your application. 

This function is primarily used when you have an approval group's unique identifier and want to retrieve the complete details related to it. These details might include the group name, the associated emails, and the date the group was created. 

A key feature of this API endpoint is its precise retrieval function. It isolates the approval group based on the unique ID, ensuring you're only getting data about the specific group you're interested in. This helps to minimize data clutter and enhances the efficiency of your application by preventing unnecessary data retrieval.

Remember that the system identifies approval groups via unique IDs, so make sure the ID used in the request is correct. If the ID does not correspond to an existing approval group, you'll not receive any data in response. 

This API endpoint can also be utilized to cross-verify data within your application. For example, after modifying the details of an approval group via a separate API call, you can use this function to confirm that the changes were applied correctly.

In short, the 'Get Approval Group by ID' function is a powerful tool for data retrieval, verification, and streamlining approval processes in your system, making it easier for various stakeholders to access and use information swiftly and accurately.

This is a header parameter that is used for authorization. You must include your unique x-api-key in the header of the API request to authenticate your request.

This is a path parameter that uniquely identifies the approval group. You need to supply the specific 'id' of the approval group you want to retrieve in this API call.

This is a response parameter that represents the name of the approval group. This could be a user-assigned name or a system-generated name.

This is a response parameter that includes an array of emails. These emails correspond to the members of the approval group.

This is a response parameter that indicates the timestamp when the approval group was created. It is automatically generated by the system in ISO 8601 format.

Successful retrieval of the approval group

Sections