How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pluggy Identity API

User identity verification and data

Pluggy Identity API is one of 24 APIs that Pluggy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Identity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.pluggy.ai.

2 operations 2 paths 18 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.pluggy.ai
Authentication
API Key
Contact
License
MIT
Resource Areas
1

Authentication & Security 1

Pluggy Identity API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (default).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Identity 2

User identity verification and data

GET
/identity
Find by item
identity-find-by-item 1 param → 200400404500
GET
/identity/{id}
Retrieve
identity-retrieve 1 param → 200400404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are IdentityResponse (30 properties), BusinessParty (14 properties), Address (12 properties), PhoneNumber (6 properties). Each schema is shown below with its type and property counts.

OtherDocument
object
Other identification document held by the natural person. Brazilian acronyms are kept verbatim; OTHER covers any other type
6 properties 2 required
PaycheckBankLink
object
Paycheck-bank (banco-folha) link to an employer, active or formerly active. Old employers may not have closed the link, so an entry doesn't guarantee the liste…
5 properties 5 required
MaritalStatus
object
Marital status of the natural person
2 properties 1 required
GeographicCoordinates
object
Geographic coordinates in decimal degrees, WGS84 reference system
2 properties 2 required
BusinessParty
object
Partner or administrator of a business. Partners with less than 25% shareholding may be omitted by the institution
14 properties 4 required
NationalityDocument
object
Supporting document for a non-Brazilian nationality
6 properties 2 required
InformedRevenue
object
Revenue (faturamento) informed by the business — the business equivalent of informedIncome
4 properties 1 required
BusinessOtherDocument
object
Additional document for businesses headquartered abroad and not required to register a CNPJ
4 properties 3 required
EconomicActivity
object
CNAE code describing one of the business's economic activities. Only one entry per response should be marked as main
2 properties 2 required
Email
object
The email object contains emails associated with the owner of the account
2 properties 1 required
Nationality
object
Nationality of the natural person
2 properties 1 required
Passport
object
Passport metadata for the natural person. Applies when the client is a non-resident not required to register a CPF
4 properties 2 required
GlobalErrorResponse
object
4 properties 2 required
PortabilityReceived
object
Salary portability received by the institution from a previous paycheck bank (banco-folha). Approved requests only — a portability is never explicitly closed,…
5 properties 5 required
IdentityResponse
object
Response with details personal information related to the owner of the connection's account
30 properties 2 required
PhoneNumber
object
The phone number object contains data related to contact information.
6 properties 1 required
Address
object
The address object contains data related to an specific owner's location.
12 properties
IdentityRelation
object
The relation object contains name and relation to the owner of the account
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pluggy-identity-api-openapi.yml Raw ↑

Other APIs Pluggy publishes across the network.

Pluggy Enrichment API
Pluggy Status API
Pluggy Account API
Pluggy Auth API
Pluggy Automatic PIX API
Pluggy Bill API
Pluggy Boleto Management API
Pluggy Category API
Pluggy Connector API
Pluggy Consent API
Pluggy Investment API
Pluggy Items API
Where this information came from

This is an independent, third-party profile of Pluggy Identity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.