Skip to main content
POST
Create agreement

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
name
string
required

Name of the agreement

Example:

"Service contract"

signerName
string
required

Name of the signer in the name of the company of the portal

Example:

"John Doe"

signerSignatureData
string
required

Base64-encoded data-string of the signature image

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAA..."

signers
object[]
required

An array of objects with information about the needed signers. Per agreement, a maximum of 5 signers is permitted.

documents
file[]
required

The documents which are part of this agreement. Maximum of 5 documents per agreement, upon a total of 5MB.

Response

Returning the created Agreement

Agreement with details

id
string

ID of the agreement, always starting with agr_.

Example:

"agr_abc12346def678"

name
string

Name of the agreement

Example:

"Service contract"

status
string

Status of the agreement. Can be sent or signed.

Example:

"sent"

signerName
string

Name of the person who signed in name of the company of the portal

Example:

"John Doe"

signerSignature
string

Base64-encoded string of the signature image

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAA..."

signerSignatureHash
string

Hash of the signerSignature in combination with the signing datetime to ensure integrity

Example:

"PwZVOc2K5rqcpqljbM2xkzJub9FtmA307pvuoJXoiqHDuEyZB7NVqdKbb3SPXt1P"

signers
object[] | null

An array with the signer(s) for this agreement

documents
object[] | null

An array with the document(s) for this agreement

createdAt
string

Date and time when the agreement is created in MijnKlantportaal, written in ATOM format.

Example:

"2025-09-13T17:23:14+02:00"