Request a signature (send OTP) - Global route

Requests a signer's signature by sending an OTP code via SMS. The person_id (owner_id or lessee_id) is automatically resolved from the JWT (auth_user_id). Minimal structure: document_signature_id and signature_data.signature_image.

post/leases/signatures/request

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/leases/signatures/request
Auth: HTTP bearer

Request body

document_signature_idstring uuid required

Unique identifier of the signature process. Obtained during initiation via POST /leases/{lease_id}/signature/initiate.

person_idstring uuid nullable

Optional. The signer's owner_id or lessee_id, when they have no auth_user_id linked to their account.

Not a way around identity checks: the JWT's email must match the signer's email for the request to be accepted.

document_declare_luboolean

The signer declares having read the document, as a guest signer already does.

It is a declaration, not proof of reading: the platform cannot certify that anyone read anything, only that they stated they had, and when. Defaults to false: a client that omits it declares nothing rather than declaring on the user's behalf.

Example request

{
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440000",
  "signature_data": {
    "signature_image": "iVBORw0KGgoAAAANSUhEUgAAASwAAACoCAMAAABt9SM9AAAAWlBMVEXm5ubv7+/x8fH19fX5+fn///8AAABERER3d3eqqqrMzMzu7u4gICAwMDBQUFBgYGCAgICQkJCgoKCwsLDAwMDQ0NDg4ODw8PBBQUFRUVFhYWFxcXGBgYGRkZGhoaE="
  }
}

Response

OTP sent successfully

object required

Dynamic response from DO Global

Example response

{
  "success": true,
  "message": "OTP code sent via SMS",
  "expires_at": "2024-01-15T10:15:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.