# Proof Types

Use the Proof Types resource to retrieve the evidence categories available for personal
Identities, business Identities, and Addresses.

A Proof Type provides a `name` and an `entity_type`. The entity type determines whether
the category applies to a personal Identity, business Identity, or Address. Proof Type
records are linked to Address Requirements and are selected when creating Proofs.

Proof Types are read-only. The complete Proof Types catalog can be filtered by entity type,
but the applicable Address Requirement determines which specific Proof Types are accepted
and how many Proofs are required for a registration.

Note

For the complete registration workflow, see [Regulation Resources](../index.html). For
an end-to-end purchasing and verification example, see [Buy a DID Number That
Requires Verification](../../../examples/buy-dids-with-verification.html).

## How Proof Types are selected

Inspect the applicable [Address Requirement](../requirements/index.html) and use the
relationship that matches the entity being verified:

| Entity Type | Address Requirement relationship | Proof entity |
| --- | --- | --- |
| `Personal` | `personal_proof_types` | Personal Identity |
| `Business` | `business_proof_types` | Business Identity |
| `Address` | `address_proof_types` | Address |

The corresponding `personal_proof_qty`, `business_proof_qty`, or
`address_proof_qty` value specifies how many Proofs are required. When the quantity is
zero, do not create a Proof for that entity. When it is greater than zero, select a Proof
Type from the matching relationship rather than choosing any catalog entry with the same
entity type.

## Endpoints

| Action | Method | Endpoint |
| --- | --- | --- |
| Retrieve all Proof Types | `GET` | `/v3/proof_types` |
| Retrieve Proof Type | `GET` | `/v3/proof_types/{id}` |

## Retrieve all Proof Types

Retrieves all Proof Types available in the DIDWW compliance catalog.

Use this endpoint to list evidence categories or filter them by `entity_type`. The
supported entity types are `Personal`, `Business`, and `Address`.

See [Retrieve All Proof Types](get-proof-types.html).

```
GET /v3/proof_types
```

## Retrieve Proof Type

Retrieves a specific Proof Type by its unique ID.

Use this endpoint when an Address Requirement identifies an accepted Proof Type and you
need to inspect its name and entity type before creating a Proof.

See [Retrieve Proof Type](get-proof-type.html).

```
GET /v3/proof_types/{id}
```

## Data reference

See [Proof Types Object](proof-types-object.html) for all attributes returned by the
resource.

## Common Proof Type use cases

| Use case | Description |
| --- | --- |
| List personal evidence categories | Filter by `Personal` to retrieve Proof Types intended for personal Identities. |
| List business evidence categories | Filter by `Business` to retrieve Proof Types intended for business Identities. |
| List address evidence categories | Filter by `Address` to retrieve Proof Types intended for Addresses. |
| Resolve an accepted type ID | Retrieve a Proof Type referenced by an Address Requirement to inspect its name and confirm the correct entity type. |
| Prepare a Proof | Use an accepted Proof Type ID with Encrypted Files and the relevant Identity or Address when creating a Proof. |
| Display regulatory requirements | Include related Proof Types when retrieving Address Requirements to show which evidence categories are accepted. |

## Related resources

- [Address Requirements](../requirements/index.html) - Determine the required proof
  quantity and the specific Proof Types accepted for each entity.
- [Proofs](../proofs/index.html) - Link an accepted Proof Type and Encrypted Files to an
  Identity or Address.
- [Encrypted Files](../encrypted-files/index.html) - Encrypt and upload the evidence linked
  to a Proof.
- [Identities](../identities/index.html) - Manage the personal or business entity to which
  a Proof can be linked.
- [Addresses](../addresses/index.html) - Manage the Address entity to which a Proof can be
  linked.

On this page