e-Próspera
Reference

Search the legal-entity registry

View as Markdown
POST
/api/v1/registries/legal_entities/search

Performs a case-insensitive name search and partial RPN match. Accepts standard and appropriately scoped Agent Keys.

Authorization

AuthorizationBearer <token>

Personal standard API key. Send it as Authorization: Bearer sk-... and never delegate it.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/registries/legal_entities/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
{  "results": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "extension": "string",      "residentPermitNumber": "string"    }  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}