canonical: https://jentic.com/apis/api.mymip.be/mymip

# Mymip Be MipRestAPI

Jentic publishes the only available OpenAPI specification for MipRestAPI, keeping it validated and agent-ready. The MIP service exposes contact lookup, indicator lookup, and a set of reference vocabulary endpoints for individuals, social entities, and legal entities. The API has 18 endpoints covering contact data ingestion, single-relation queries, indicator queries, URN lookups by email address, and reference data such as countries, languages, genders, legal forms, and unique-ID code lists. It is suited to back-office systems that need a controlled vocabulary plus contact lookups against the MIP register.

## For AI agents

Look up contacts and reference data in the MIP register: ingest contact data, query a relation's contact and indicators, search by URN or email, and fetch reference vocabularies for countries, languages, genders, and legal forms.

## Scope

Does not handle payment processing, document storage, or messaging - use for MIP register contact and reference data lookups only.

## Capabilities

- Ingest contact data into the MIP register for both standard and tagged entries
- Retrieve all contact data attached to a specific relation (individual, social entity, or legal entity)
- Retrieve the indicator flags attached to a specific relation for downstream business logic
- Search the register for URN identifiers associated with a given email address
- Look up the controlled vocabulary of attribute codes and types for individuals, social entities, and legal entities
- Fetch reference lists of countries, languages, genders, legal-form codes, and unique-ID codes
- Run arbitrary search queries against the MIP register via the search endpoint

## Use cases

### Contact Data Enrichment

Use the MIP register to enrich a CRM contact record by looking up URNs by email via /GetURNs_t and then pulling all contact data and indicators for the matched relation. This produces a structured, controlled-vocabulary view that downstream business rules can rely on. Most teams build the enrichment in 2 to 3 days.

Example prompt: Call /GetURNs_t with the email 'jane@example.com', take the first URN, then call /GetContact_t and /GetIndicators_t for that URN and merge the data into the CRM record.

### Reference Vocabulary Synchronisation

Pull the MIP reference vocabularies (countries, languages, genders, legal forms, unique-ID codes, attribute codes and types) into a local cache so that data-entry forms and validation logic stay aligned with the canonical register. Sync nightly via a single batch of GET calls. Effort is typically a day for a basic refresh job.

Example prompt: Pull /RefCountries_t, /RefLanguages_t, /RefGenders_t, /RefLegalFormCodes_t, and /RefUniqueIDCodes_t and write each list to a local reference table with the current sync timestamp.

### Indicator-Driven Business Rules

Surface the indicator flags attached to a relation via /GetIndicators_t and feed them into downstream eligibility, compliance, or routing logic. Pair with /RefIndicators_t to translate raw indicator codes into human-readable labels. Setup takes 1 to 2 days for the lookup and rule wiring.

Example prompt: Call /GetIndicators_t for relation URN 12345 and check whether any returned indicator code matches the deny list defined in /RefIndicators_t.

### AI Agent Register Lookup

An AI agent supporting customer service can answer 'is there an MIP record for jane@example.com' by calling /GetURNs_t and /GetContact_t through Jentic. Credentials live in your Jentic One instance and never enter agent context. Setup is under an hour.

Example prompt: Use Jentic to search for 'find URNs by email', execute /GetURNs_t with the user-supplied email, then call /GetContact_t for the returned URN and summarise the contact for the agent.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /GetContact_t | Get contact data for a relation |
| GET | /GetIndicators_t | Get indicators for a relation |
| GET | /GetURNs_t | Get URNs associated with an email address |
| POST | /AddContactData_t | Add contact data for a relation |
| GET | /RefIndicators_t | List available indicator codes |
| GET | /RefCountries_t | List country reference codes |
| GET | /Search_t | Search the MIP register |

## Key resources

- **Contact Data** — Add and retrieve contact data attached to MIP relations
- **Indicators** — Retrieve indicator flags attached to a relation and list all available indicator codes
- **URN Lookup** — Find URNs associated with a given email address
- **Search** — Run search queries against the MIP register
- **Attribute Reference** — List attribute codes and types valid for individuals, social entities, and legal entities
- **General Reference** — Reference lists of countries, languages, genders, legal forms, and unique-ID codes

## Why Jentic

- **Setup:** Wiring the MipRestAPI by hand means setting up its API key auth and coding your own calls across the contact, indicator, and reference lookup endpoints. Through Jentic you install once, import the MipRestAPI from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** MipRestAPI lookup filters travel as request parameters rather than as ids in the URL path, so limit the agent to the operations it needs, such as GetContact_t and Search_t, and leave AddContactData_t out of the allowed set. Every operation you grant is your explicit choice.
- **Credential handling:** Your MipRestAPI key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'look up a MIP register contact' or 'search reference indicators', and Jentic returns the matching MipRestAPI operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Clearbit API** — Commercial contact and company enrichment service
- **People Data Labs API** — Person enrichment service with email and identifier matching
- **Hunter.io API** — Email finder and verifier for outbound prospecting

## FAQ

### Why is there no official OpenAPI spec for MipRestAPI?

MIP does not publish a public OpenAPI specification beyond the raw Swagger surface. Jentic generates and maintains this spec so that AI agents and developers can call MipRestAPI via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does MipRestAPI use?

MipRestAPI uses an API token under the apiToken apiKey scheme. The token is provisioned by MIP and sent on every request. Through Jentic, the token is stored encrypted in your Jentic One instance and the agent receives only a scoped session at execution time.

### Can I look up MIP relations by email with MipRestAPI?

Yes. GET /GetURNs_t accepts an email address and returns the URN identifiers associated with relations that match. Use the returned URN as input to /GetContact_t and /GetIndicators_t to pull the full contact and indicator data.

### What are the rate limits for MipRestAPI?

MIP does not publish a public rate limit policy. Limits are tied to your token tier - contact MIP support to confirm the per-second and per-day caps that apply to your account.

### How do I retrieve contact data for a relation with MipRestAPI through Jentic?

Run pip install jentic, then search for 'get contact data for a relation'. Jentic returns the GET /GetContact_t operation schema. Execute it with the relation URN and the agent receives the structured contact payload to merge into your CRM.

### Does MipRestAPI return controlled-vocabulary reference lists?

Yes. The reference endpoints (/RefCountries_t, /RefLanguages_t, /RefGenders_t, /RefLegalFormCodes_t, /RefUniqueIDCodes_t, /RefIndicators_t, and the attribute code and type endpoints) return the canonical vocabularies the rest of the API relies on.

### Can I limit what my agent is allowed to do with the MipRestAPI?

Yes. Jentic One runs in your own self-hosted instance, and your rules decide which MipRestAPI operations and credentials the agent may use. You can allow read-only lookups such as GetContact_t, GetIndicators_t, GetURNs_t, and Search_t while leaving the write operation AddContactData_t out of the permitted set. Because MipRestAPI lookup filters travel as request parameters rather than as ids in the URL path, every operation the agent can call is your explicit, per-operation choice.