How to submit a contract signature

You can submit a signature for a contract by using the following URL and specifying the required parameters.

 

 Method URL
 POST  https://api.fairwarningsoftware.com/v1.1.1/contract/sign/[item-contract-id]

 

Request
{
        "contract_signature": <contract_signature>,
        "typed_name": <typed_name>,
        "contract_insurance": <contract_insurance>
}

 

 Field  Type Description
contract_signature string This is the contents of the "output" field from the signature page when the user signs using the mouse.
typed_name string This is the name typed into the text box when the user types their name to sign.
contract_insurance bool Whether the user declines insurance for their items.

 

If successful, a success response will be returned.  If not, an error will be returned instead.

 Status Response
 200 {
        "success": <success>,
       
"message": <message>
}
401  {"error":"The API keys provided are invalid."}
403  {"error":"API keys are missing."}
500  {"error": <custom error>}

 

 Field  Type Description
success bool Whether or not the request was successful
message string A message that may be shown to the user.