curl --request GET \
--url https://api.verify.privue.ai/verifications/{verification_id}/contracts/preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.verify.privue.ai/verifications/{verification_id}/contracts/preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.verify.privue.ai/verifications/{verification_id}/contracts/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"contract_workflow": "dealer-agreement",
"filled": {
"dealer_name": "Asha Traders Private Limited",
"gstin": "27AABCA1234F1Z5"
},
"open": [
"credit_limit",
"start_date"
],
"required": [
"credit_limit",
"start_date"
],
"required_one_of": [],
"dates": [
"start_date"
],
"signers": [
{
"name": "Asha Rao",
"mobile": "9876543210",
"email": "asha@ashatraders.example"
}
],
"sent": [],
"stamp_paper": null,
"faults": []
}{
"code": "unauthenticated",
"detail": "Missing or malformed Authorization header"
}{
"code": "environment-mismatch",
"detail": "workflow 'merchant-onboarding' is production and this request is for uat"
}{
"code": "verification-not-found",
"detail": "version 3 of this verification's workflow offers no contract workflow 'dealer-agreement'"
}{
"code": "verification-expired",
"detail": "this verification has expired and its data is deleted, so no contract can be drawn up from it"
}{
"code": "page-cursor-invalid",
"detail": "cursor: not one we issued"
}{
"code": "rate-limited",
"detail": "Unauthorized: RATE_LIMITED"
}{
"code": "workflow-misconfigured",
"detail": "contract workflow 'dealer-agreement' is offered but not registered"
}{
"code": "auth-unavailable",
"detail": "Auth provider unavailable"
}Preview a contract
Draw up what sending this contract would carry now, without sending, spending or recording anything.
Answers the values the verification fills in, the variables you set with the send, everyone it would go to, the contracts of this contract workflow already sent on the verification’s current run, and every fault that would refuse a send whatever you set. Build a send from it: set every variable in open and send.
curl --request GET \
--url https://api.verify.privue.ai/verifications/{verification_id}/contracts/preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.verify.privue.ai/verifications/{verification_id}/contracts/preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.verify.privue.ai/verifications/{verification_id}/contracts/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"contract_workflow": "dealer-agreement",
"filled": {
"dealer_name": "Asha Traders Private Limited",
"gstin": "27AABCA1234F1Z5"
},
"open": [
"credit_limit",
"start_date"
],
"required": [
"credit_limit",
"start_date"
],
"required_one_of": [],
"dates": [
"start_date"
],
"signers": [
{
"name": "Asha Rao",
"mobile": "9876543210",
"email": "asha@ashatraders.example"
}
],
"sent": [],
"stamp_paper": null,
"faults": []
}{
"code": "unauthenticated",
"detail": "Missing or malformed Authorization header"
}{
"code": "environment-mismatch",
"detail": "workflow 'merchant-onboarding' is production and this request is for uat"
}{
"code": "verification-not-found",
"detail": "version 3 of this verification's workflow offers no contract workflow 'dealer-agreement'"
}{
"code": "verification-expired",
"detail": "this verification has expired and its data is deleted, so no contract can be drawn up from it"
}{
"code": "page-cursor-invalid",
"detail": "cursor: not one we issued"
}{
"code": "rate-limited",
"detail": "Unauthorized: RATE_LIMITED"
}{
"code": "workflow-misconfigured",
"detail": "contract workflow 'dealer-agreement' is offered but not registered"
}{
"code": "auth-unavailable",
"detail": "Auth provider unavailable"
}Authorizations
Query Parameters
Response
What a send would carry now, and what would refuse it.
What sending one of a verification's offers now would carry, and what would refuse it.
Every reason a send now would be refused that setting open would not put right: the verification not waiting on signatures, its run not signed on this contract workflow, one of these already out or signed, no contract credits left, or a value or file the verification does not hold. On a contract filled from a form whose open is empty, it also names everything the form cannot print. Empty where a send with every open value set would go, unless the contract as drawn up with those values is refused for how it prints.
