Skip to main content
POST
Generate mandate signature request

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

customerId
string
required

the customer id

Pattern: ^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
paymentMethodId
string
required
Pattern: ^payment_method(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

Body

application/json
deliveryMode
enum<string>
required

the delivery mode

Available options:
EMAIL,
URL
test
boolean

Force test mode to skip Yousign. Defaults to isTestId(customerId).

Response

id
string
required

the signature id

Pattern: ^signature(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
signers
object[]
required

the signers