Getting Started
A guide to creating and retrieving individual Legal Entities from start to finish.
AvailabilityLegal Entity endpoints are available from API version
202610. Configure your API key (or request headers) to use that version or a newer one that includes these routes.
Legal Entities
Legal Entities represent people and businesses that can operate with Devengo products. This first release focuses on individuals: create one with identity details, retrieve it by a stable lei_ identifier while KYC and product capabilities progress, and send a signup short link by SMS when needed.
Company onboarding continues to use the existing Account Holders API.
Why it matters
A dedicated surface for individuals. Individuals use a composite government identifier (type, value, country_code) instead of a company tax ID. Responses expose due diligence progress and product capabilities without mixing that shape into the company Account Holder API.
Clear product gating. Each individual returns capabilities for accounts, payments, and incoming_payments. Those stay disabled until verification succeeds, then flip to enabled.
Stable references. Every individual gets a lei_ ID you can store and fetch later via GET /v1/legal_entities/individuals/{id}.
Create a Sandbox Account
Unless you already use other Devengo products, create a Sandbox account first:
- Sign up at this form.
- Confirm the email to unlock the Control Panel and API.
Create an API Key
Generate an API key in the API Keys section of the Control Panel for version 202610.
Sign every request as described in Authentication. Use API version 202610 (or newer) so Legal Entity routes are available.
Create an individual
curl -X POST https://api.sandbox.devengo.com/v1/legal_entities/individuals \
-H 'Content-Type: application/json' \
-H "X-Devengo-Api-Key-Id: your_api_key_id" \
-H "X-Devengo-Api-Key-Nonce: your_nonce" \
-H "X-Devengo-Api-Key-Timestamp: your_timestamp" \
-H "X-Devengo-Api-Key-Signature: your_signature" \
-d '{
"first_name": "Ada",
"last_name": "Lovelace",
"phone_number": "+34666666666",
"email": "[email protected]",
"locale": "es",
"company_reference": "cust-1",
"identifier": {
"type": "tax_id",
"value": "12345678Z",
"country_code": "ES"
}
}'You will get a response with this structure:
{
"individual": {
"id": "lei_4KO9GZj1NP8yqldgstJpam",
"name": "Ada Lovelace",
"email": "[email protected]",
"phone_number": "+34666666666",
"company_reference": "cust-1",
"status": "created",
"identifier": {
"type": "tax_id",
"value": "12345678Z",
"country_code": "ES"
},
"unresolved_checks": [],
"capabilities": {
"accounts": "disabled",
"payments": "disabled",
"incoming_payments": "disabled"
}
}
}See also POST /v1/legal_entities/individuals.
Retrieve an individual
curl -X GET https://api.sandbox.devengo.com/v1/legal_entities/individuals/lei_4KO9GZj1NP8yqldgstJpam \
-H "X-Devengo-Api-Key-Id: your_api_key_id" \
-H "X-Devengo-Api-Key-Nonce: your_nonce" \
-H "X-Devengo-Api-Key-Timestamp: your_timestamp" \
-H "X-Devengo-Api-Key-Signature: your_signature"unresolved_checks lists due diligence checks that are not yet resolved (for example an opened KYC). Once verification suceeds, capabilities become enabled.
See also GET /v1/legal_entities/individuals/{id}.
Send a signup link
Trigger a signup SMS for an existing individual. Each call creates a new short link and returns its public URL:
curl -X POST https://api.sandbox.devengo.com/v1/legal_entities/individuals/lei_4KO9GZj1NP8yqldgstJpam/signup \
-H "X-Devengo-Api-Key-Id: your_api_key_id" \
-H "X-Devengo-Api-Key-Nonce: your_nonce" \
-H "X-Devengo-Api-Key-Timestamp: your_timestamp" \
-H "X-Devengo-Api-Key-Signature: your_signature"{
"link": "https://le.devengo.com/lnk/abc123XY/signup"
}See also POST /v1/legal_entities/individuals/{id}/signup.
Identifier types
identifier.type uses the same vocabulary as elsewhere in the API:
| Type | Typical use |
|---|---|
id_card | National identity card |
passport | Passport |
tax_id | Tax identifier (more common for companies) |
registration_number | Commercial registration |
lei | Legal Entity Identifier |
Updated 4 days ago