canonical: https://jentic.com/apis/proovidapi.azurewebsites.net/proovidapi-azurewebsites

# Proovidapi Proovid Electronic Verification

Proovid API is a RESTful application that specializes in electronic verification (Proof of address and Proof of Identity) by employing an advanced risk-tiered approacch in combination with a smart Risk assessment system. <a href='docs/PROOVid_ELV.pdf' target='_blank'>More information</a>. The API exposes 33 endpoints secured with apiKey authentication.

## For AI agents

Programmatically address_verifybyid, address_verifybyid. Covers 33 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- Address_verifyById
- Address_verifyCertificatePdf
- Address_verifyByLevel
- Address_createNaturalPersonElv
- Address_linkResponse
- Document_verifyStatus

## Use cases

### Identity and Authentication Operations

Use the Proovid Electronic Verification to perform identity auth operations programmatically. The API provides 33 endpoints covering core functionality including address_verifybyid, address_verifybyid, address_verifycertificatepdf.

Example prompt: Call GET `/api/Address/AddressVerification/{id}` to address_verifybyid

### Automated NaturalPerson Management

Automate naturalperson operations by combining multiple Proovid Electronic Verification endpoints. Agents can address_verifybyid and then address_verifycertificatepdf in a single workflow.

Example prompt: Call DELETE `/api/Address/AddressVerification/{id}` to address_verifybyid, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Proovid Electronic Verification endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'address_verifybyid', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/Address/AddressVerification/{id}` | Address_verifyById |
| DELETE | `/api/Address/AddressVerification/{id}` | Address_verifyById |
| GET | `/api/Address/AddressVerification/{id}/certificate.pdf` | Address_verifyCertificatePdf |
| POST | `/api/Address/VerificationByLevel` | Address_verifyByLevel |
| POST | `/api/Address/NaturalPersonELV` | Address_createNaturalPersonElv |
| POST | `/api/Address/LinkResponse` | Address_linkResponse |
| GET | `/api/Document/DocumentVerification/{id}` | Document_verifyStatus |
| DELETE | `/api/Document/DocumentVerification/{id}` | Document_verifyDeletion |

## Key resources

- **NaturalPerson** — Operations related to NaturalPerson
- **Address** — Operations related to Address
- **Document** — Operations related to Document
- **Screening** — Operations related to Screening
- **Health** — Operations related to Health

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 10 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 72 / 100
  - Developer Experience & Jentic Compatibility: 62 / 100
  - AI-Readiness & Agent Experience: 3 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/proovidapi.azurewebsites.net/proovidapi-azurewebsites/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Proovid Electronic Verification by hand means setting its API key in the Authorization header, tracking verification ids across the address and document flows, and handling errors yourself. Through Jentic you install once, import Proovid Electronic Verification from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Proovid puts the verification id in the URL path (`/api/Address/AddressVerification/{id}` and `/api/Document/DocumentVerification/{id}`), so a rule can pin your agent to reading a specific verification. You choose the operations it may call, so destructive ones like deleting an address or document verification are not included unless you add them.
- **Credential handling:** Your Proovid Electronic Verification API 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 'verify an address' or 'fetch a document verification result', and Jentic returns the matching Proovid operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the Proovid Electronic Verification use?

The Proovid Electronic Verification uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I address_verifybyid with the Proovid Electronic Verification?

Yes. Use the GET `/api/Address/AddressVerification/{id}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Proovid Electronic Verification?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I address_verifybyid through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'address_verifybyid'. Jentic returns the matching Proovid Electronic Verification operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Proovid Electronic Verification have?

The Proovid Electronic Verification exposes 33 endpoints covering naturalperson, address, document operations.

### Can I limit what my agent is allowed to do with the Proovid Electronic Verification API?

Yes. Because Jentic One is self-hosted and you set its rules, you decide exactly which Proovid operations your agent may call and which API key it uses. Proovid puts the verification id in the URL path, such as `/api/Address/AddressVerification/{id}` and `/api/Document/DocumentVerification/{id}`, so a rule can pin the agent to reading a specific verification. Destructive operations like the DELETE on an address or document verification stay out of reach unless you explicitly grant them.