> For the complete documentation index, see [llms.txt](https://mydentify.gitbook.io/mydentify-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mydentify.gitbook.io/mydentify-docs/models.md).

# Models

## The ProductCategory object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"ProductCategory":{"type":"object","required":["slug","name","description","externalMappings","approvedProductCount"],"properties":{"slug":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"externalMappings":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"approvedProductCount":{"type":"integer","minimum":0}}}}}}
```

## The DirectoryRecord object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"DirectoryRecord":{"type":"object","required":["type","id","name","slug","domain","websiteUrl","canonicalUrl","jsonUrl","llmsTextUrl","description","category","pricing","link","directoryScore","scoreConfidence","verificationStatus","operatingStatus","updatedAt"],"properties":{"type":{"const":"directory-record"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"domain":{"type":"string"},"websiteUrl":{"type":"string","format":"uri"},"submissionUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"canonicalUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"llmsTextUrl":{"type":"string","format":"uri"},"description":{"type":"string"},"category":{"type":"string"},"pricing":{"type":"object","additionalProperties":true},"link":{"type":"object","additionalProperties":true},"directoryScore":{"type":"integer","minimum":0,"maximum":100},"scoreConfidence":{"type":"number","minimum":0,"maximum":1},"domainRating":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"verificationStatus":{"type":"string"},"operatingStatus":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}}}}}}
```

## The ImportRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"ImportRequest":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"mode":{"type":"string","enum":["diagnostic","listing"],"default":"listing"},"requestedIntentSlug":{"type":"string"},"source":{"type":"string","enum":["human","agent"],"default":"human"},"submittedByAgent":{"type":"string","maxLength":120}}}}}}
```

## The ImportAccepted object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"ImportAccepted":{"type":"object","required":["importId","status","statusUrl","eventsUrl","submittedAt","reused","nextAction"],"properties":{"importId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","running","needs_input","retry_scheduled","duplicate_detected","ready_for_confirmation","submitted_for_review","approved","rejected","failed","canceled"]},"statusUrl":{"type":"string","format":"uri"},"eventsUrl":{"type":"string","format":"uri"},"submittedAt":{"type":"string","format":"date-time"},"reused":{"type":"boolean"},"nextAction":{"type":"object","additionalProperties":true}}}}}}
```

## The CanonicalProduct object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"CanonicalProduct":{"type":"object","required":["id","name","slug","status","url","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string"},"url":{"type":"string","format":"uri"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}}}}}
```

## The DuplicateResolution object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"DuplicateResolution":{"type":"object","required":["classification","matchType","confidence","reason","claimed","product","proposedChanges","allowedActions"],"properties":{"classification":{"type":"string","enum":["exact_duplicate","probable_duplicate","renamed_product"]},"matchType":{"type":"string"},"confidence":{"type":"number","minimum":0,"maximum":1},"reason":{"type":"string"},"claimed":{"type":"boolean"},"product":{"$ref":"#/components/schemas/CanonicalProduct"},"proposedChanges":{"type":"array","items":{"type":"object","required":["field","proposed","sourceUrl"],"properties":{"field":{"type":"string"},"current":{},"proposed":{},"sourceUrl":{"type":"string","format":"uri"}}}},"allowedActions":{"type":"array","items":{"type":"object","required":["type","href"],"properties":{"type":{"type":"string","enum":["view_existing","claim_product","restore_access","review_proposed_updates"]},"href":{"type":"string"}}}}}},"CanonicalProduct":{"type":"object","required":["id","name","slug","status","url","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string"},"url":{"type":"string","format":"uri"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}}}}}
```

## The DryRunResult object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"DryRunResult":{"type":"object","required":["normalizedUrl","finalUrl","canonicalUrl","identity","discovered","nextAction"],"properties":{"normalizedUrl":{"type":"string","format":"uri"},"finalUrl":{"type":"string","format":"uri"},"canonicalUrl":{"type":"string","format":"uri"},"identity":{"type":"object","additionalProperties":true},"duplicate":{"anyOf":[{"$ref":"#/components/schemas/DuplicateResolution"},{"type":"null"}]},"discovered":{"type":"object","additionalProperties":true},"nextAction":{"type":"object","additionalProperties":true}}},"DuplicateResolution":{"type":"object","required":["classification","matchType","confidence","reason","claimed","product","proposedChanges","allowedActions"],"properties":{"classification":{"type":"string","enum":["exact_duplicate","probable_duplicate","renamed_product"]},"matchType":{"type":"string"},"confidence":{"type":"number","minimum":0,"maximum":1},"reason":{"type":"string"},"claimed":{"type":"boolean"},"product":{"$ref":"#/components/schemas/CanonicalProduct"},"proposedChanges":{"type":"array","items":{"type":"object","required":["field","proposed","sourceUrl"],"properties":{"field":{"type":"string"},"current":{},"proposed":{},"sourceUrl":{"type":"string","format":"uri"}}}},"allowedActions":{"type":"array","items":{"type":"object","required":["type","href"],"properties":{"type":{"type":"string","enum":["view_existing","claim_product","restore_access","review_proposed_updates"]},"href":{"type":"string"}}}}}},"CanonicalProduct":{"type":"object","required":["id","name","slug","status","url","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string"},"url":{"type":"string","format":"uri"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}}}}}
```

## The ImportStatus object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"ImportStatus":{"type":"object","required":["id","status","attemptCount","nextAction","stages","candidates","sourceFetches"],"properties":{"id":{"type":"string","format":"uuid"},"mode":{"type":"string","enum":["diagnostic","listing"]},"status":{"type":"string","enum":["queued","running","needs_input","retry_scheduled","duplicate_detected","ready_for_confirmation","submitted_for_review","approved","rejected","failed","canceled"]},"attemptCount":{"type":"integer","minimum":0},"nextAction":{"type":"object","additionalProperties":true},"remediation":{"anyOf":[{"$ref":"#/components/schemas/Remediation"},{"type":"null"}]},"duplicate":{"anyOf":[{"$ref":"#/components/schemas/DuplicateResolution"},{"type":"null"}]},"publication":{"anyOf":[{"$ref":"#/components/schemas/Publication"},{"type":"null"}]},"rejection":{"anyOf":[{"$ref":"#/components/schemas/Rejection"},{"type":"null"}]},"readinessReport":{"anyOf":[{"$ref":"#/components/schemas/ReadinessReport"},{"type":"null"}]},"stages":{"type":"array","items":{"type":"object","additionalProperties":true}},"candidates":{"type":"array","items":{"type":"object","additionalProperties":true}},"sourceFetches":{"type":"array","items":{"type":"object","additionalProperties":true}},"warnings":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"Remediation":{"type":"object","required":["summary","actions"],"properties":{"summary":{"type":"string"},"actions":{"type":"array","items":{"type":"object","required":["type","label","href"],"properties":{"type":{"type":"string","enum":["retry","retry_after","try_another_url","manual_review"]},"label":{"type":"string"},"href":{"type":"string"},"retryAfter":{"type":"string","format":"date-time"}}}}}},"DuplicateResolution":{"type":"object","required":["classification","matchType","confidence","reason","claimed","product","proposedChanges","allowedActions"],"properties":{"classification":{"type":"string","enum":["exact_duplicate","probable_duplicate","renamed_product"]},"matchType":{"type":"string"},"confidence":{"type":"number","minimum":0,"maximum":1},"reason":{"type":"string"},"claimed":{"type":"boolean"},"product":{"$ref":"#/components/schemas/CanonicalProduct"},"proposedChanges":{"type":"array","items":{"type":"object","required":["field","proposed","sourceUrl"],"properties":{"field":{"type":"string"},"current":{},"proposed":{},"sourceUrl":{"type":"string","format":"uri"}}}},"allowedActions":{"type":"array","items":{"type":"object","required":["type","href"],"properties":{"type":{"type":"string","enum":["view_existing","claim_product","restore_access","review_proposed_updates"]},"href":{"type":"string"}}}}}},"CanonicalProduct":{"type":"object","required":["id","name","slug","status","url","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string"},"url":{"type":"string","format":"uri"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}},"Publication":{"type":"object","required":["productId","humanUrl","jsonUrl","markdownUrl","supportedIntents"],"properties":{"productId":{"type":"string","format":"uuid"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"},"supportedIntents":{"type":"array","items":{"type":"object","required":["id","title","slug","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"slug":{"type":"string"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}}}}},"Rejection":{"type":"object","required":["category","message","correctionHint","publicNote"],"properties":{"category":{"type":"string","enum":["identity_unclear","insufficient_public_evidence","unsupported_or_private_source","duplicate_listing","inaccurate_claims","unsafe_or_prohibited"]},"message":{"type":"string"},"correctionHint":{"type":"string"},"publicNote":{"type":"string"}}},"ReadinessReport":{"type":"object","required":["rubricVersion","status","totalScore","confidence","summary","sourceCount","scannedAt","dimensions"],"properties":{"rubricVersion":{"type":"string"},"status":{"type":"string","enum":["complete","partial"]},"totalScore":{"type":"integer","minimum":0,"maximum":100},"confidence":{"type":"number","minimum":0,"maximum":1},"summary":{"type":"string"},"sourceCount":{"type":"integer","minimum":0},"scannedAt":{"type":"string","format":"date-time"},"dimensions":{"type":"array","minItems":5,"maxItems":5,"items":{"type":"object","required":["key","label","score","maxScore","summary","findings"],"properties":{"key":{"type":"string","enum":["product_understood","intent_coverage","evidence_strength","agent_accessibility","recommendation_readiness"]},"label":{"type":"string"},"score":{"type":"integer","minimum":0,"maximum":20},"maxScore":{"const":20},"summary":{"type":"string"},"findings":{"type":"array","items":{"type":"object","required":["code","label","status","score","maxScore","recommendation","evidence"],"properties":{"code":{"type":"string"},"label":{"type":"string"},"status":{"type":"string","enum":["passed","partial","failed","unavailable","not_applicable"]},"score":{"type":"number"},"maxScore":{"type":"number"},"recommendation":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}}}
```

## The ReadinessReport object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"ReadinessReport":{"type":"object","required":["rubricVersion","status","totalScore","confidence","summary","sourceCount","scannedAt","dimensions"],"properties":{"rubricVersion":{"type":"string"},"status":{"type":"string","enum":["complete","partial"]},"totalScore":{"type":"integer","minimum":0,"maximum":100},"confidence":{"type":"number","minimum":0,"maximum":1},"summary":{"type":"string"},"sourceCount":{"type":"integer","minimum":0},"scannedAt":{"type":"string","format":"date-time"},"dimensions":{"type":"array","minItems":5,"maxItems":5,"items":{"type":"object","required":["key","label","score","maxScore","summary","findings"],"properties":{"key":{"type":"string","enum":["product_understood","intent_coverage","evidence_strength","agent_accessibility","recommendation_readiness"]},"label":{"type":"string"},"score":{"type":"integer","minimum":0,"maximum":20},"maxScore":{"const":20},"summary":{"type":"string"},"findings":{"type":"array","items":{"type":"object","required":["code","label","status","score","maxScore","recommendation","evidence"],"properties":{"code":{"type":"string"},"label":{"type":"string"},"status":{"type":"string","enum":["passed","partial","failed","unavailable","not_applicable"]},"score":{"type":"number"},"maxScore":{"type":"number"},"recommendation":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}}}
```

## The Remediation object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"Remediation":{"type":"object","required":["summary","actions"],"properties":{"summary":{"type":"string"},"actions":{"type":"array","items":{"type":"object","required":["type","label","href"],"properties":{"type":{"type":"string","enum":["retry","retry_after","try_another_url","manual_review"]},"label":{"type":"string"},"href":{"type":"string"},"retryAfter":{"type":"string","format":"date-time"}}}}}}}}}
```

## The Publication object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"Publication":{"type":"object","required":["productId","humanUrl","jsonUrl","markdownUrl","supportedIntents"],"properties":{"productId":{"type":"string","format":"uuid"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"},"supportedIntents":{"type":"array","items":{"type":"object","required":["id","title","slug","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"slug":{"type":"string"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}}}}}}}}
```

## The Rejection object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"Rejection":{"type":"object","required":["category","message","correctionHint","publicNote"],"properties":{"category":{"type":"string","enum":["identity_unclear","insufficient_public_evidence","unsupported_or_private_source","duplicate_listing","inaccurate_claims","unsafe_or_prohibited"]},"message":{"type":"string"},"correctionHint":{"type":"string"},"publicNote":{"type":"string"}}}}}}
```

## The Error object

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"components":{"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfter":{"type":"string","format":"date-time"}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://mydentify.gitbook.io/mydentify-docs/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.