CAcardda
Company

Generate PLH contracts

Generates the PLH contract documents for the company and emails them for signing. Requires the company to have plh_enabled true and its KYC verification_status to be approved; otherwise a 400 with an error_code is returned.

post/v1/companies/{id}/plh/generate_contracts

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/companies/{id}/plh/generate_contracts
  • Auth
    HTTP bearer

Path parameters

idstring required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Parameters

#/paths/~1v1~1users/get/parameters/0 (unresolved $ref)

Response

Contracts generated and email sent.

messagestring

Example response

{
  "message": "Contracts generated and mail sent"
}

Changes

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