IRCC - Create

Overview

This documentation describes the API endpoint for creating a new IRCC (Internationally Recognized Certificate of Compliance) record using the POST method. The endpoint allows clients to submit a new record to the system, enabling the creation and storage of compliance certificates or other related documentation.

Introduction

Permits or their equivalent constituting an internationally recognized certificate of compliance (IRCC) are critical for ensuring that genetic resources are accessed in accordance with prior informed consent (PIC) and that mutually agreed terms (MAT) have been established. The IRCC serves as evidence that these conditions have been met and plays a key role in monitoring and enhancing transparency about the utilization of genetic resources.

To access this API, users must be affiliated with a government entity and possess one of the following roles: National Focal Point (NFP), National Authorized User (NAU), or Government Representative. These roles ensure that the individuals have the authority and responsibility to manage genetic resources and compliance certificates.

Moreover, the API and associated token are restricted to use within the context of a single government. Users cannot use the token for multiple governments or share it for cross-government operations. This restriction ensures that the process remains secure and that each government's compliance is managed independently.

Key Provisions

1. Issuance of Permit or Equivalent: At the time of access, a permit or its equivalent is issued as evidence of the decision to grant PIC and the establishment of MAT.
2. Publication to ABS Clearing-House: This information is made available to the ABS Clearing-House in accordance with relevant articles of the Convention on Biological Diversity (CBD).
3. Constitution of IRCC: Once the information is published in the ABS Clearing-House, an internationally recognized certificate of compliance is constituted.
4. Role of IRCC: The IRCC serves as evidence that the genetic resource covered has been accessed in accordance with PIC and MAT. It includes essential information such as issuing authority, date of issuance, provider, unique identifier, subject-matter or genetic resources covered, and confirmation of MAT and PIC.

Parties are required to fill out the form with mandatory fields to ensure the IRCC is constituted. Confidential information should not be submitted as all information made available to the ABS Clearing-House will be public.

Endpoint

POST /api/v2013/documents

This is the endpoint to which the POST request should be made to create a new record.

Header

The request must include the following headers:

Field	Type	Description
Content-Type	String	Specifies the media type of the request body. This header indicates the format of the data being sent to the server. The allowed value is application/json, which means the request body is formatted as JSON. This helps the server understand how to parse and process the incoming data.
Authorization	String	Provides the token used to authenticate the request. This header is essential for identifying and verifying the client making the request. The token should be included in the header to gain access to protected resources or services. Ensure that the token is kept secure and is valid for the requested operation.
Realm	String	Defines the specific context or environment in which the Clearing-House request is being made. The allowed values are abs, chm, and bch, each representing different operational contexts. This helps the server route the request appropriately based on the specified realm.
Accept	String	Specifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the client prefers the response in JSON format. This informs the server of the desired response format, ensuring that the client receives data in a readable and expected format.

Headers required to authenticate and define the context and format of the request and response. The Authorization header must contain a valid token, while the Content-Type and Accept headers specify the format of the document and response, respectively. Here are the steps to get the Authorization token.

Realm Values:

Applications	Development Realm	Production Realm
ABS Clearing House	abs-dev	abs

Query Parameters

The following query parameters can be used to refine the request:

Field	Type	Description
schema	String	Defines the schema or format of the record being posted. This field specifies the type of record and the structure it adheres to. The schema value helps the system understand how to interpret and validate the incoming data. It ensures that the record conforms to a predefined format or standard, facilitating consistency and compatibility across different parts of the system. The schema value typically corresponds to a specific schema definition or type that dictates the required fields, data types, and constraints for the record.

URL Parameters

The following URL parameter is required:

Field	Type	Description
uid	String	A unique identifier for the record. This value is case-sensitive and must conform to the regular expression /^[A-Za-z0-9\-_]{11,128}$/. This pattern allows for a combination of uppercase and lowercase letters, numbers, hyphens, and underscores, with a length ranging from 11 to 128 characters. The uid is crucial for uniquely identifying and retrieving the record within the system, ensuring that each record can be distinctly referenced and managed. It plays a key role in operations such as fetching, updating, or deleting the record, as well as in maintaining the integrity of record management processes.

Validation Errors

The table below provides descriptions for each error type that may appear in the "errors" property. These errors are intended to help identify missing or incorrect fields and values within the record parameter, enabling precise adjustments to meet validation requirements.

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

Request Body

The table below outlines the structure of the request body, including the fields, their types, and whether they are mandatory. Example values are provided for clarity.

Title	Field	Mandatory	Type	Example
	header		Header	{ "identifier": "CB51626B-CF45-2AA0-3A24-459669DDCC34", "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 (YYYY-MM-DD)	"2024-07-02"
Prior Informed Consent (PIC) Information (Select any of the two from below)
The provider	providers	True	Reference[]	[ { "identifier": "DECLARE-ORGANISATION_3386_20240709020251617@1" } ]
This information is confidential	providersConfidential		bool	{providersConfidential: true}
Person or entity to whom prior informed consent (PIC) was granted
	entitiesToWhomPICGranted	True	Reference[]	[ { "identifier": "DECLARE-ORGANISATION_3386_20240709020251617@1" } ]
This information is confidential	entitiesToWhomPICGrantedConfidential		bool	true
Subject-matter or genetic resource (Select any of the two from below)
1. Subject-matter or genetic resources covered by the permit or its equivalent	subjectMatter	True	lstring	{"en": " asdf " }
2. This information is confidential	subjectMatterConfidential		bool	{subjectMatterConfidential: true}
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
Additional subject-matter or genetic resources information (Select any one of the three below)
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	AmendmentIntent
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	bool	true
Additional information about the prior informed consent (PIC)	picInformation		lstring	{ "en": " asdfasdfasdf " }
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	bool	true
Additional information about the mutually agreed terms (MAT) - Information	matInformation		lstring	{ "en": " asdf " }
Additional information about the mutually agreed terms (MAT) - Documents	matDocuments		Link[]	[ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]
Information on the utilization of the genetic resource(s) (Select any one of the below)
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		bool	true
Additional information about the specified uses covered by the permit or its equivalent or use restrictions	usagesDescription		lstring	{ "en": " asdf " }
Conditions for third party transfer	thirdPartyTransferCondition		lstring	{ "en": " asdf " }
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": " asdf " }
Additional Information	relevantInformation		lstring	{ "en": " asfd " }
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" } ]

Playground

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.