Search

Metadata API

 

This API returns the digitized data for all key terms (enabled for API) for the specified Pramata Number.

 

Version Comparison

Note: Version 2 is the current API version. Version 1 is deprecated and no longer available. Existing Version 1 users will be migrated to Version 2 at their next integration request.

Feature Version 2 Version 1
Status Current version Deprecated - no longer available
Data Organization

Structured records collection

  • Organized with total counts
  • Each record contains detailed information objects
  • Hierarchical data structure

Simple lists

  • Basic schema definitions
  • Flat key-value pairs
  • Minimal structure
Value Presentation

Rich data objects containing

  • Element name
  • Actual value
  • Citation information
  • Additional metadata

Plain key-value pairs

  • Direct value representation
    Example: "Status": "Fully Signed"
  • No additional context
Citation Tracking

Full citation support

  • Page numbers
  • Document references
  • Pramata numbers
  • Complete traceability for each value

No citation tracking

  • No page numbers
  • No document references
  • No traceability data
Data Type Handling

Dynamic type detection

  • Types determined from value field
  • Flexible and context-aware
  • No separate schema needed

Static schema definition

  • Types in separate schema object
    Example: "Status": "string"
  • Fixed type declarations

 

Version 2

Version with enhanced citation tracking - Returns detailed metadata including page numbers and document references for better traceability.

 

API Request

Request Type: GET

API Endpoint: https://{customer}-api-{environment}.pramata.com/services/data/v2/documents/{pramata_number}/details

Example: https://demos-api.pramata.com/services/data/v2/documents/11275/details

 

Input Parameters

  • pramata_number (required)

Notes: total_records(that is, max number of terms) per key term that the API will respond is 2000. For your information, 1 term is one row with multiple columns.

 

API Response

HTTP status code 200

{
"meta": {
"pramata_number": "11275"
},
"data": {
"metadata": {
"pramata_number": "11275",
"effective_date": "2024-01-19",
"document_title": "Master Services Agreement",
"company_group": "Acme Management Corporation",
"contract_type": "Master Agreement",
"parent_pramata_number": null,
"pdf_url": "https://demos-uat.pramata.com/services/data/v1/documents/11275/pdf"
},
"keyterms": [
{
"keyterm_api_name": "sk___Seller_Entity",
"total_records": 1,
"records": [
{
"Seller_Entity_Name": {
"data_element_api_name": "Seller_Entity_Name",
"value": "CLOUDPRO, INC.,",
"citation_page_no": 13,
"citation_pramata_number": 11275
}
}
]
},
{
"keyterm_api_name": "sk___Buyer_Entity",
"total_records": 1,
"records": [
{
"Buyer_Entity_Name": {
"data_element_api_name": "Buyer_Entity_Name",
"value": "Tyrell Corporation",
"citation_page_no": 1,
"citation_pramata_number": 11275
}
}
]
},
{
"keyterm_api_name": "sk___Contract_Term_Renewal",
"total_records": 1,
"records": [
{
"Present": {
"data_element_api_name": "Present",
"value": "Yes",
"citation_page_no": 5,
"citation_pramata_number": 11275
},
"Term_Type": {
"data_element_api_name": "Term_Type",
"value": "Fixed Term",
"citation_page_no": 1,
"citation_pramata_number": 11275
},
"Term_Trigger": {
"data_element_api_name": "Term_Trigger",
"value": "External Start Date",
"citation_page_no": 1,
"citation_pramata_number": 11275
},
"Initial_Term_Months": {
"data_element_api_name": "Initial_Term_Months",
"value": "12",
"citation_page_no": 1,
"citation_pramata_number": 11275
},
"Multiple_Terms_Specified": {},
"Renewal_Term_Months": {},
"Coterminous_with_Sibling": {},
"Total_Number_Of_Renewals": {},
"Non_Renewal_Notice_Period_Days": {},
"Fixed_Commencement_Date": {},
"Fixed_Expiration_Date": {},
"Termination_Date": {},
"Contract_Start_Date": {
"data_element_api_name": "Contract_Start_Date",
"value": "2024-01-19"
},
"Contract_End_Date": {
"data_element_api_name": "Contract_End_Date",
"value": "2026-09-01"
},
"Contract_End_Date_Driven_By": {
"data_element_api_name": "Contract_End_Date_Driven_By",
"value": "Initial Term"
},
"Contract_Renewal_Type": {
"data_element_api_name": "Contract_Renewal_Type",
"value": "No Auto-Renewal"
},
"Contract_Active_Period_Days": {
"data_element_api_name": "Contract_Active_Period_Days",
"value": "454"
},
"Contract_Number_Of_Renewals_Le": {},
"Contract_Initial_Term_Expirati": {
"data_element_api_name": "Contract_Initial_Term_Expirati",
"value": "2026-09-01"
},
"Contract_Notice_Period_Require": {
"data_element_api_name": "Contract_Notice_Period_Require",
"value": "0"
},
"Contract_Next_Renewal_Date": {
"data_element_api_name": "Contract_Next_Renewal_Date",
"value": "2026-09-01"
},
"Contract_Non_Renewal_Notice_Da": {
"data_element_api_name": "Contract_Non_Renewal_Notice_Da",
"value": "2026-09-01"
},
"Contract_Status": {
"data_element_api_name": "Contract_Status",
"value": "Active"
}
}
]
},
{
"keyterm_api_name": "Asset_Line_Item",
"total_records": 1,
"records": [
{
"Product_Family": {
"data_element_api_name": "Product_Family",
"value": "Cloudii Network 360 Platform",
"citation_page_no": 1,
"citation_pramata_number": 11275
},
"Pricing": {
"data_element_api_name": "Pricing",
"value": "Yes"
},
"Product_Master_Family": {
"data_element_api_name": "Product_Master_Family",
"value": "Cloudii Network 360 Platform",
"citation_page_no": 1,
"citation_pramata_number": 11275
}
}
]
},
{
"keyterm_api_name": "sk___Doc_Source",
"total_records": 2,
"records": [
{
"Doc_Reference_Id": {},
"External_Start_Date": {},
"External_End_Date": {},
"Account_Category": {
"data_element_api_name": "Account_Category",
"value": "Customer"
}
},
{
"Doc_Reference_Id": {},
"External_Start_Date": {
"data_element_api_name": "External_Start_Date",
"value": "2025-09-02"
},
"External_End_Date": {
"data_element_api_name": "External_End_Date",
"value": "2026-08-21"
},
"Account_Category": {}
}
]
},
{
"keyterm_api_name": "sk___Assignment",
"total_records": 1,
"records": [
{
"Present": {
"data_element_api_name": "Present",
"value": "Yes",
"citation_page_no": 2,
"citation_pramata_number": 11275
}
}
]
},
{
"keyterm_api_name": "sk___Limitation_of_Liability",
"total_records": 1,
"records": [
{
"Present": {
"data_element_api_name": "Present",
"value": "Yes",
"citation_page_no": 9,
"citation_pramata_number": 11275
}
}
]
}
]
}
}

 

CAM Keyterms Support

API now supports Clause Analysis Model (CAM) keyterms in addition to standard keyterms, enabling extraction of advanced contract analysis data through the same unified API response structure.

HTTP status code 200

{
"meta": {
"pramata_number": "10109"
},
"data": {
"metadata": {
"pramata_number": "10109",
"effective_date": "1900-11-11",
"document_title": "MERCHANT PROCESSING AGREEMENT TERMS AND CONDITIONS",
"company_group": "Worldpay Integrated Payments",
"contract_type": "Master Agreement",
"parent_pramata_number": null,
"pdf_url": "https://demos-uat.pramata.com/services/data/v1/documents/10109/pdf"
},
"keyterms": [
{
"keyterm_api_name": "sk___Seller_Entity",
"total_records": 1,
"records": [
{
"Seller_Entity_Name": {
"data_element_api_name": "Seller_Entity_Name",
"value": "cloudii from FIS"
}
}
]
},
{
"keyterm_api_name": "std__Assignment__Change_of_Control_Treatment",
"total_records": 1,
"records": [
{
"Present": {
"data_element_api_name": "Present",
"value": "Yes"
}
}
]
}
]
}
}


HTTP status code 404

{
"errors": [
{
"status": "404",
"source": {
"pointer": "https://demos.pramata.com/api/v2/contracts/1084/details"
},
"title": "Invalid Pramata Number",
"detail": "No matching Contracts found in the repository for the given Pramata Number"
}
]
}


HTTP status code 401

{
"errors": [
{
"status": "401",
"source": {
"pointer": "https://demos.pramata.com/api/v2/contracts/10014/details"
},
"title": "Permission denied for requested contract",
"detail": "Sorry, but looks like you do not have access to this document / Contract is not published yet. Please contact your admin to request access"
}
]
}

 

Version 1

Note: This version will be discontinued in the future. Please migrate to Version 2 for continued support and enhanced features.

 

API Request

Request Type: GET

API Endpoint: https://{customer}-api-{environment}.pramata.com/services/data/v1/documents/{pramata_number}/details

Example: https://demos-api.pramata.com/services/data/v1/documents/10814/details

 

Input Parameters

  • pramata_number (required)

Notes: total_records(that is, max number of terms) per key term that the API will respond is 2000. For your information, 1 term is one row with multiple columns.

 

API Response

HTTP status code 200

{
"meta": {
"pramata_number": "10814"
},
"data": {
"metadata": {
"pramata_number": "10814",
"effective_date": "2015-01-01",
"document_title": "Enterprise License Agreement",
"company_group": "Genesys International (Future State)",
"contract_type": "Master Agreement",
"parent_pramata_number": null,
"pdf_url": "https://demos.pramata.com/services/data/v1/documents/10814/pdf"
},
"keyterms": [
{
"keyterm_api_name": "sk___Signature",
"schema": {
"Status": "string"
},
"total_records": 1,
"terms": [
{
"Status": "Fully Signed"
}
]
},
{
"keyterm_api_name": "sk___Seller_Entity",
"schema": {
"Seller_Entity_Name": "string"
},
"total_records": 1,
"terms": [
{
"Seller_Entity_Name": "Tech25 Inc."
}
]
},
{
"keyterm_api_name": "sk___Buyer_Entity",
"schema": {
"Buyer_Entity_Name": "string"
},
"total_records": 1,
"terms": [
{
"Buyer_Entity_Name": "Genesys International Inc."
}
]
},
{
"keyterm_api_name": "sk___Contract_Term_Renewal",
"schema": {
"Term_Type": "string",
"Term_Trigger": "string",
"Initial_Term_Months": "integer",
"Renewal_Term_Months": "integer",
"Coterminous_with_Sibling": "integer",
"Total_Number_Of_Renewals": "integer",
"Non_Renewal_Notice_Period_Days": "integer",
"Fixed_Commencement_Date": "date",
"Fixed_Expiration_Date": "date",
"Termination_Date": "date",
"Contract_Start_Date": "date",
"Contract_End_Date": "date",
"Contract_End_Date_Driven_By": "string",
"Contract_Renewal_Type": "string",
"Contract_Active_Period_Days": "integer",
"Contract_Number_Of_Renewals_Le": "integer",
"Contract_Initial_Term_Expirati": "date",
"Contract_Notice_Period_Require": "boolean",
"Contract_Next_Renewal_Date": "date",
"Contract_Non_Renewal_Notice_Da": "date",
"Contract_Status": "string"
},
"total_records": 1,
"terms": [
{
"Term_Type": "Initial Term with Auto-Renewal",
"Term_Trigger": "Contract Start Date",
"Initial_Term_Months": "36",
"Renewal_Term_Months": "12",
"Coterminous_with_Sibling": null,
"Total_Number_Of_Renewals": null,
"Non_Renewal_Notice_Period_Days": "60",
"Fixed_Commencement_Date": null,
"Fixed_Expiration_Date": null,
"Termination_Date": null,
"Contract_Start_Date": "2015-01-01",
"Contract_End_Date": "2022-12-31",
"Contract_End_Date_Driven_By": "Renewal",
"Contract_Renewal_Type": "Auto-Renewal",
"Contract_Active_Period_Days": "2874",
"Contract_Number_Of_Renewals_Le": null,
"Contract_Initial_Term_Expirati": "2017-12-31",
"Contract_Notice_Period_Require": "1",
"Contract_Next_Renewal_Date": "2022-12-31",
"Contract_Non_Renewal_Notice_Da": "2022-11-01",
"Contract_Status": "Active"
}
]
}
]
}
}


HTTP status code 404

{
"errors": [
{
"status": "404",
"source": {
"pointer": "https://demos.pramata.com/api/v1/contracts/1084/details"
},
"title": "Invalid Pramata Number",
"detail": "No matching Contracts found in the repository for the given Pramata Number"
}
]
}


HTTP status code 401

{
"errors": [
{
"status": "401",
"source": {
"pointer": "https://demos.pramata.com/api/v1/contracts/10014/details"
},
"title": "Permission denied for requested contract",
"detail": "Sorry, but looks like you do not have access to this document / Contract is not published yet. Please contact your admin to request access"
}
]
}