Query parameters

• status array[string]

  Filter mandate signature requests by status.

  Values are sent, expired, or completed.

• page integer(int32) Deprecated

  Index of the requested page. Deprecated, use page_token instead.

  Minimum value is 1.

• page_token string

  Token used to fetch a specific page, as returned by the next_page_token or prev_page_token field of a previous response. Mutually exclusive with page.

• size integer(int32)

  Number of elements per page in response.

  Minimum value is 1, maximum value is 100. Default value is 10.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • results array[object] Required

    Elements of the page.

    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.

  • has_prev boolean Required Deprecated

    Flag indicating if there is a previous page. Deprecated, use prev_page_token instead.

  • has_next boolean Required Deprecated

    Flag indicating if there is a next page. Deprecated, use next_page_token instead.

  • next_page_token string | null

    Token to fetch the next page, to be passed in subsequent requests as the page_token query parameter. null when there is no next page.

  • prev_page_token string | null

    Token to fetch the previous page, to be passed in subsequent requests as the page_token query parameter. null when there is no previous page.