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

# Models

## The ApiErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"Ospree Address API","version":"2.0.0"},"components":{"schemas":{"ApiErrorResponse":{"properties":{"status":{"type":"string","title":"Status","default":"error"},"code":{"type":"integer","title":"Code","description":"Duplicates the HTTP status; use `error_code`. Removed in v3."},"message":{"type":"string","title":"Message"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code","description":"Stable, machine-readable error code, e.g. `auth.unauthenticated`. Additive-only."},"data":{"anyOf":[{},{"type":"null"}],"title":"Data"}},"type":"object","required":["code","message"],"title":"ApiErrorResponse","description":"*summary*: Api error response model"}}}}
```

## The ApiFailResponse object

```json
{"openapi":"3.1.0","info":{"title":"Ospree Address API","version":"2.0.0"},"components":{"schemas":{"ApiFailResponse":{"properties":{"status":{"type":"string","title":"Status","default":"fail"},"message":{"type":"string","title":"Message"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code","description":"Stable, machine-readable error code, e.g. `auth.unauthenticated`. Additive-only."},"data":{"anyOf":[{},{"type":"null"}],"title":"Data"}},"type":"object","required":["message"],"title":"ApiFailResponse","description":"*summary*: Api fail response model"}}}}
```

## The ApiSuccessResponse object

```json
{"openapi":"3.1.0","info":{"title":"Ospree Address API","version":"2.0.0"},"components":{"schemas":{"ApiSuccessResponse":{"properties":{"status":{"type":"string","title":"Status","default":"success"},"data":{"anyOf":[{},{"type":"null"}],"title":"Data"}},"type":"object","title":"ApiSuccessResponse","description":"*summary*: Api success response model"}}}}
```

## The RequestVerificationRequestCom object

```json
{"openapi":"3.1.0","info":{"title":"Ospree Address API","version":"2.0.0"},"components":{"schemas":{"RequestVerificationRequestCom":{"properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Deprecated and ignored. Ospree does not send anything to this address. The verification link is returned in the response body, and delivering it to the wallet holder is the caller's responsibility. Any value supplied is discarded rather than stored.","deprecated":true}},"type":"object","title":"RequestVerificationRequestCom"}}}}
```

## The ScreenAddressRequestCom object

```json
{"openapi":"3.1.0","info":{"title":"Ospree Address API","version":"2.0.0"},"components":{"schemas":{"ScreenAddressRequestCom":{"properties":{"scan_for_risk":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Scan For Risk","description":"Whether to scan for risk when creating new address","default":false},"provider_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Name","description":"The name of the risk provider to screen with, for example `RDBIG`. Leave it out, or send `null`, to use your business's default risk provider. When sent, it must be a non-empty provider name: a blank or whitespace-only value is rejected with 422."},"is_self_hosted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Self Hosted","description":"Whether the wallet is self-hosted","default":false},"account_ref_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Ref Id","description":"The reference ID of the account"},"link_type":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Link Type","description":"The type of link","default":1}},"type":"object","title":"ScreenAddressRequestCom"}}}}
```