Internationally Recognized Certificate of Compliance - Update

Overview

Updates an existing Internationally Recognized Certificate of Compliance record in the ABS Clearing-House and re-runs the publishing workflow — identifier check, securities, validation, draft and workflow — in a single call.

Endpoint

PUT /api/v2023/documents/schemas/absPermit/:identifier

Headers

Header	Required	Description
Content-Type	Yes	Media type of the request body. The allowed value is application/json.
Authorization	Yes	Bearer token authenticating the request (Bearer <token>). Obtain it from the User - Authentication endpoint.
Accept	No	Format the client expects in the response. The allowed value is application/json.
Realm	No	The Clearing-House context. May be sent here instead of the realm query parameter.

Path Parameters

Parameter	Description
schema	The record type being updated: absPermit.
identifier	The record's unique identifier. Must match the document's header.identifier.

Query Parameters

Parameter	Required	Description
realm	Yes	The Clearing-House context. For this application and environment: abs. May alternatively be sent as the Realm HTTP header.

Request Body

The request body is a JSON object with three top-level fields:

Field	Type	Required	Description
document	Object	Yes	The record itself — the fields listed below, wrapped in a document object (its header plus the record-type fields).
additionalInfo	String	No	Up to 1000 characters. Available only when a user with the NAU role submits a request to the Publishing Authority (PA) to publish a record.
batchId	String	No	Up to 100 characters. Batches multiple records together for publishing.

The fields of the document object are below.

Title	Field	Mandatory	Type	Example
	header		Header	{ "identifier": "068C83BA-995F-08C3-50CE-AD43545B3EB5", "schema": "absPermit", "languages": ["en"] }
Country	government	True	Term	{"identifier":"af"}
	updateReason		lstring
Competent national authority (CNA) responsible for issuing this permit or its equivalent	absCNA	True	Reference	{"identifier":"C84C7E6C-134C-F1B1-9A3B-B7443F135239@2"}
Reference number of the permit or its equivalent	title	True	lstring	{"en":"123456"}
Additional national references or identifiers	referenceToNationalPermit		lstring	{"en":"strsgfsgfdxgf"}
Date of issuance of the permit or its equivalent	dateOfIssuance	True	Date	2024-07-02
The provider	providers	True	Reference[]	[{"identifier":"DECLARE-ORGANISATION_3386_20240709020251617@1"}]
This information is confidential	providersConfidential		Boolean
	entitiesToWhomPICGranted	True	Reference[]	[{"identifier":"DECLARE-ORGANISATION_3386_20240709020251617@1"}]
This information is confidential	entitiesToWhomPICGrantedConfidential		Boolean	true
1. Subject-matter or genetic resources covered by the permit or its equivalent	subjectMatter	True	lstring	{"en":"<div><!--block-->asdf</div>"}
2. This information is confidential	subjectMatterConfidential		Boolean
Keywords to describe the subject-matter or genetic resource(s) covered by the permit or its equivalent	keywords		Term[]	[{"identifier":"357DBB22-6A6C-4C49-BA1F-037320B09247"}]
Other keywords	keywordOther	True	lstring
1. Specimen data	specimens		Link[]	[{"url":"https://www.Google.com","name":"Google","language":"en"}]
2. Taxonomy	taxonomies		Link[]	[{"url":"https://www.google.com","name":"Google","language":"en"}]
3. Geographic coordinates	gisFiles		Link[]
	gisMapCenter		MapLocation
Amendment intent	amendmentIntent	True	string
Provide a summary of the reason for the update of the record	amendmentDescription	True	lstring
Confirmation that prior informed consent (PIC) was obtained or granted	picGranted	True	Boolean	true
Additional information about the prior informed consent (PIC)	picInformation		lstring	{"en":"<div><!--block-->asdfasdfasdf</div>"}
Additional information about the prior informed consent (PIC) - Documents	picDocuments		Link[]	[{"url":"https://www.google.com","name":"Google","language":"en"}]
Confirmation that mutually agreed terms (MAT) were established	matEstablished	True	Boolean	true
Additional information about the mutually agreed terms (MAT) - Information	matInformation		lstring	{"en":"<div><!--block-->asdf</div>"}
Additional information about the mutually agreed terms (MAT) - Documents	matDocuments		Link[]	[{"url":"https://www.google.com","name":"Google","language":"en"}]
1. Indicate if the permit or its equivalent covers commercial and/or non-commercial use	usages	True	Term[]	[{"identifier":"5E833A3F-87D1-4ADD-8701-9F1B76383017"}]
2. This information is confidential	usagesConfidential		Boolean	true
Additional information about the specified uses covered by the permit or its equivalent or use restrictions	usagesDescription		lstring	{"en":"<div><!--block-->asdf</div>"}
Conditions for third party transfer	thirdPartyTransferCondition		lstring	{"en":"<div><!--block-->asdf</div>"}
Date of expiry of the permit or its equivalent	dateOfExpiry		Date	2024-07-16
Copy of the permit or its equivalent, or other relevant open-access document	permitFiles		Link[]	[{"url":"https://www.google.com","name":"Google","language":"en"}]
Short description of the attached link(s) and/or file(s)	permitDescription		lstring	{"en":"<div><!--block-->asdf</div>"}
Additional Information	relevantInformation		lstring	{"en":"<div><!--block-->asfd</div>"}
Other relevant website addresses and/or attached documents	relevantDocuments		Term[]	[{"url":"https://www.google.com","name":"Google","language":"en"}]
Notes	notes		string	["[ Pramod Sam | Jul 8, 2024 8:10:52 PM ] - aasdfasdf"]
Links to other internationally recognized certificate(s) of compliance (IRCC) that relate(s) to this permit	relatedIRCC		Reference[]	[{"identifier":"8C22B282-BE5A-72D8-C754-932CC49CC9B4@1"}]

Response

A successful call returns the saved draft and the publishing workflow that was started. Validation failures also return HTTP 200, with an errors array in the body instead — always check the response body, not just the status code.

When the document fails validation, the issues are returned in the errors property of the response (with HTTP 200). Each entry names the error code and the property it applies to:

{
  "identifier": "DECLARE-ORGANISATION_5885_20241031144831187",
  "errors": [
    { "code": "Error.Mandatory", "property": "government" }
  ]
}

Error Type	Description
Error.Mandatory	A required field is missing.
Error.MandatoryAnyOf	At least one field from a set of mandatory fields is missing.
Error.InvalidValue	The provided value is not valid according to the schema.
Error.InvalidProperty	An invalid property or field name.
Error.UnspecifiedLocale	A locale or language code is missing or invalid.
Error.UnexpectedTerm	An unexpected term or parameter.
Error.InvalidType	The provided data type is not valid.

Errors

The following error conditions may occur while interacting with the API. Each entry describes a specific error status code, along with an error message explaining the issue and any additional requirements for successful execution.

Status Code	Description
400	realm param is missing, please provide valid realm in querystring or httpHeaders.
400	Realm is not configured, please provide valid realm.
400	Schema not configured for the given realm.
400	A document with the identifier exists, please use a different identifier.
400	A document with the identifier does not exist, please provide correct identifier to update.
400	The record is locked for workflow, cannot proceed.
403	Insufficient rights to create a draft record.
403	Insufficient rights to update the draft record.
403	Authorization required, user is anonymous.

Playground

This playground connects to the production environment (api.cbd.int). Requests made here affect real, live data.

This is a protected route. To access this content, you need to be logged in. Logging in will provide you with an authentication token, which is required for making API calls.

Swagger playground is loading, please wait...

An error occurred while loading Swagger playground, please refresh the page.

Legacy alternative. Publishing through the legacy v2013 API uses the Save Draft endpoint plus a workflow call; new integrations should use this single v2023 call instead. The record's other draft operations (drafts, locks, securities, validation, versions) are documented under Draft Operations.