Open and self-service

Validate
the envelope.

NCP schema validation checks whether a document is structurally well-formed for a selected schema version.

NCP schema validation.

What it checks

Is the document valid JSON?
Are required NCP fields present?
Do values use the expected data types?
Does the document match the selected NCP schema version?

What it does not check

It does not determine whether profile-owned information is complete, coherent, correct, or meaningful within that profile's narrative system.

NCP schema validation confirms that a document is structurally well-formed. It does not determine whether a profile payload is complete, coherent, or semantically valid.

Schema quickstart.

Install the repository dependencies, verify the Core schema and examples, or check one NCP document from the command line.

$ npm install
$ npm run validate:schema
$ npm run validate:file -- ./document.ncp.json

Profile checks are separate.

A profile can publish its own structural schema and conformance process. Tools should report Core schema results and profile results separately.