Create a new mandate signature request

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://docs.api.memo.bank/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Memo Bank API MCP server": {
    "url": "https://docs.api.memo.bank/mcp"
  }
}

POST /v2/mandate_signature_requests

An email will be sent to the mandate debtor so they can complete and sign the collection mandate.

Scope: mandate-signature-requests:write

application/json

Body object Required

reference string Required

The unique mandate reference.

Format should match the following pattern: ^[A-Za-z0-9+?/\-:().,'\s]{1,35}$.
scheme string Required

The mandate scheme.

Values are b2b or core.
language string

The language used for the email and signature page for the debtor. This is optional.

Values are french or english. Default value is french.
mode string Required Discriminator

Define the delivery strategy of this signature request.

Value is email.
debtor object

Debtor data used to prefill the signing form. All fields are optional; the debtor can still edit them before signing.
Hide debtor attributes Show debtor attributes object
- name string
  
  Name of the debtor.
  
  Minimum length is 1, maximum length is 256.
- iban string
  
  IBAN of the debtor.
  
  Format should match the following pattern: ^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$.
- address object
  
  Debtor address used to prefill the signing form. All fields are optional.
  Hide address attributes Show address attributes object
  
  street string
  
  Name of the street.
  
  Minimum length is 1, maximum length is 256.
  
  postal_code string
  
  Postal or zip code.
  
  Minimum length is 1, maximum length is 256.
  
  city string
  
  Name of the city.
  
  Minimum length is 1, maximum length is 256.
  
  country string
  
  ISO3166-1 alpha-2 country code.
  
  Format should match the following pattern: ^[A-Z]{2}$.
contract_reference string

The contract reference that will be attached to the mandate. This is optional metadata.

Minimum length is 1, maximum length is 256.
debtor_email string Required

The email address of the debtor.

Minimum length is 1, maximum length is 256. Format should match the following pattern: ^(?!.*\.\.)[a-zA-Z0-9._%+-]{1,250}@[a-zA-Z0-9.-]{2,250}\.[a-zA-Z]{2,63}$.
email_custom_message string

Custom text message that will be included in the email sent to the debtor.

Minimum length is 1, maximum length is 3000. Format should match the following pattern: ^[a-zA-Zà-üÀ-Ü0-9€@&;.,?!()+\-'’"\s]*$.

reference string Required

The unique mandate reference.

Format should match the following pattern: ^[A-Za-z0-9+?/\-:().,'\s]{1,35}$.
scheme string Required

The mandate scheme.

Values are b2b or core.
language string

The language used for the email and signature page for the debtor. This is optional.

Values are french or english. Default value is french.
mode string Required Discriminator

Define the delivery strategy of this signature request.

Value is redirect.
debtor object

Debtor data used to prefill the signing form. All fields are optional; the debtor can still edit them before signing.
Hide debtor attributes Show debtor attributes object
- name string
  
  Name of the debtor.
  
  Minimum length is 1, maximum length is 256.
- iban string
  
  IBAN of the debtor.
  
  Format should match the following pattern: ^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$.
- address object
  
  Debtor address used to prefill the signing form. All fields are optional.
  Hide address attributes Show address attributes object
  
  street string
  
  Name of the street.
  
  Minimum length is 1, maximum length is 256.
  
  postal_code string
  
  Postal or zip code.
  
  Minimum length is 1, maximum length is 256.
  
  city string
  
  Name of the city.
  
  Minimum length is 1, maximum length is 256.
  
  country string
  
  ISO3166-1 alpha-2 country code.
  
  Format should match the following pattern: ^[A-Z]{2}$.
contract_reference string

The contract reference that will be attached to the mandate. This is optional metadata.

Minimum length is 1, maximum length is 256.
debtor_email string Required

The email address of the debtor.

Minimum length is 1, maximum length is 256. Format should match the following pattern: ^(?!.*\.\.)[a-zA-Z0-9._%+-]{1,250}@[a-zA-Z0-9.-]{2,250}\.[a-zA-Z]{2,63}$.
redirect_uri string Required

URI to redirect the debtor after signing. Must be an absolute HTTPS URL.

Minimum length is 1, maximum length is 2048. Format should match the following pattern: ^https://[a-zA-Z0-9.\-]{1,255}(:[0-9]{1,5})?(/[^\s]*)?$.

Responses

200 application/json

OK
One of:
email object redirect object
Hide attributes Show attributes

reference string Required

The unique mandate reference.

Format should match the following pattern: ^[A-Za-z0-9+?/\-:().,'\s]{1,35}$.

id string(uuid) Required

ID of the mandate signature request.

scheme string Required

The mandate scheme.

Values are b2b or core.

language string Required

The language used for the email and signature page for the debtor.

Values are french or english. Default value is french.

status string Required

Current status of the mandate signature request.

Values are sent, expired, or completed.

mode string Required Discriminator

Define the delivery strategy of this signature request.

Value is email.

is_deleted boolean Required

Whether or not this mandate signature request has been deleted.

debtor object

Debtor information filled when the request was signed. This is available when the request is completed.

Hide debtor attributes Show debtor attributes object

name string Required

Debtor's name.

iban string Required

Debtor's IBAN.

address object

Debtor's address.

Hide address attributes Show address attributes object

street string Required

Debtor's street name.

postal_code string Required

Debtor's postal code.

city string Required

Debtor's city.

country string Required

Debtor's country code.

contract_reference string

The contract reference attached to the mandate. This is optional metadata.

debtor_email string Required

The email address of the debtor.

email_custom_message string

Custom text message included in the email sent to the debtor.
Hide attributes Show attributes

reference string Required

The unique mandate reference.

Format should match the following pattern: ^[A-Za-z0-9+?/\-:().,'\s]{1,35}$.

id string(uuid) Required

ID of the mandate signature request.

scheme string Required

The mandate scheme.

Values are b2b or core.

language string Required

The language used for the email and signature page for the debtor.

Values are french or english. Default value is french.

status string Required

Current status of the mandate signature request.

Values are sent, expired, or completed.

mode string Required Discriminator

Define the delivery strategy of this signature request.

Value is redirect.

is_deleted boolean Required

Whether or not this mandate signature request has been deleted.

debtor object

Debtor information filled when the request was signed. This is available when the request is completed.

Hide debtor attributes Show debtor attributes object

name string Required

Debtor's name.

iban string Required

Debtor's IBAN.

address object

Debtor's address.

Hide address attributes Show address attributes object

street string Required

Debtor's street name.

postal_code string Required

Debtor's postal code.

city string Required

Debtor's city.

country string Required

Debtor's country code.

contract_reference string

The contract reference attached to the mandate. This is optional metadata.

debtor_email string Required

The email address of the debtor.

signature_url string Required

URL the debtor must visit to sign the mandate.

redirect_uri string Required

URL the debtor is redirected to after signing.

POST /v2/mandate_signature_requests

curl \
 --request POST 'https://api.memo.bank/v2/mandate_signature_requests' \
 --header "Content-Type: application/json" \
 --data '{"reference":"ABC123DEF","scheme":"core","language":"french","mode":"email","debtor":{"name":"John Doe","iban":"FR2512739000308553756377J95","address":{"street":"rue de la Boétie","postal_code":"75008","city":"Paris","country":"FR"}},"contract_reference":"CUST-1234","debtor_email":"foo@bar.com","email_custom_message":"Hi John Doe, here's a collection mandate to sign."}'

Request examples

{
  "reference": "ABC123DEF",
  "scheme": "core",
  "language": "french",
  "mode": "email",
  "debtor": {
    "name": "John Doe",
    "iban": "FR2512739000308553756377J95",
    "address": {
      "street": "rue de la Boétie",
      "postal_code": "75008",
      "city": "Paris",
      "country": "FR"
    }
  },
  "contract_reference": "CUST-1234",
  "debtor_email": "foo@bar.com",
  "email_custom_message": "Hi John Doe, here's a collection mandate to sign."
}

{
  "reference": "ABC123DEF",
  "scheme": "core",
  "language": "french",
  "mode": "redirect",
  "debtor": {
    "name": "John Doe",
    "iban": "FR2512739000308553756377J95",
    "address": {
      "street": "rue de la Boétie",
      "postal_code": "75008",
      "city": "Paris",
      "country": "FR"
    }
  },
  "contract_reference": "CUST-1234",
  "debtor_email": "foo@bar.com",
  "redirect_uri": "https://example.com/signed"
}

Response examples (200)

{
  "reference": "ABC123DEF",
  "id": "61b05c4f-3f72-4951-8c30-a2a9faaa5184",
  "scheme": "core",
  "language": "french",
  "status": "sent",
  "mode": "email",
  "is_deleted": false,
  "debtor": {
    "name": "John Doe",
    "iban": "FR2512739000308553756377J95",
    "address": {
      "street": "1 rue Rivoli",
      "postal_code": "75004",
      "city": "Paris",
      "country": "FR"
    }
  },
  "contract_reference": "CUST-1234",
  "debtor_email": "foo@bar.com",
  "email_custom_message": "Hi John Doe, here's a collection mandate to sign."
}

{
  "reference": "ABC123DEF",
  "id": "61b05c4f-3f72-4951-8c30-a2a9faaa5184",
  "scheme": "core",
  "language": "french",
  "status": "sent",
  "mode": "redirect",
  "is_deleted": false,
  "debtor": {
    "name": "John Doe",
    "iban": "FR2512739000308553756377J95",
    "address": {
      "street": "1 rue Rivoli",
      "postal_code": "75004",
      "city": "Paris",
      "country": "FR"
    }
  },
  "contract_reference": "CUST-1234",
  "debtor_email": "foo@bar.com",
  "signature_url": "https://client.memo.bank/mandate/abc123",
  "redirect_uri": "https://example.com/signed"
}