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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenMercantil

OpenMercantil User API

Authenticated Panel Pro endpoints — segments, lists, notes, tags, exports, audit. Requires session cookie (browser) and X-CSRF-Token header for mutations.

Documentation Provider Profile APIs.io OpenAPI GitHub

OpenMercantil User API is one of 25 APIs that OpenMercantil publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 65 operations across 44 paths, and defines 89 schemas. It is described by OpenAPI 3.2.0, at version 1.9.3.

Requests are made against a single base URL, https://openmercantil.es.

65 operations 44 paths 89 schemas 9 DELETE21 GET4 PATCH26 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.9.3
Server
https://openmercantil.es
Authentication
API Key, API Key, HTTP Bearer
Contact
OpenMercantil
License
Source-specific upstream terms; see response catalog metadata
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

OpenMercantil User API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as ob_sess (cookieAuth). An API key is passed in the header as X-API-Key (apiKey). It accepts HTTP bearer tokens (opaque omk_* credential) (bearerAuth).

  • cookieAuth — Browser session cookie set after login at /mi-cuenta/login. Mutations also require X-CSRF-Token header (obtain via GET /api/v1/user/me).
  • apiKey — Optional opaque omk API credential for public GETs. Anonymous access remains valid; a credential with the operation's x-api-credential-scope (or public:read) s…
  • bearerAuth — Optional Authorization: Bearer transport for the same opaque omk API credential accepted by X-API-Key. It is not a JWT or OAuth access token.

Paths & Operations 65

Across 44 paths, the API surfaces 65 operations — 9 DELETE, 21 GET, 4 PATCH, 26 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

User 65

Authenticated Panel Pro endpoints — segments, lists, notes, tags, exports, audit. Requires session cookie (browser) and X-CSRF-Token header for mutations.

GET
/api/v1/user/me
Current authenticated user
getUserMe → 200401
GET
/api/v1/user/org
Get the current organization, seats and visible members
getUserOrganization → 200401503
POST
/api/v1/user/org
Create an organization
createUserOrganization 1 param body → 201400401402403409503
PUT
/api/v1/user/org
Rename the current organization
updateUserOrganization 1 param body → 200400401403404503
POST
/api/v1/user/org/invites
Create or renew an organization invitation
createUserOrganizationInvite 1 param body → 201400401403409429503
POST
/api/v1/user/org/invites/{id}/resend
Rotate and resend an organization invitation
resendUserOrganizationInvite 2 params → 200401403404409429503
DELETE
/api/v1/user/org/invites/{id}
Cancel a pending organization invitation
deleteUserOrganizationInvite 2 params → 200401403404503
PUT
/api/v1/user/org/members/{id}
Change an organization member role
updateUserOrganizationMember 2 params body → 200400401403404503
DELETE
/api/v1/user/org/members/{id}
Remove a member from the organization
deleteUserOrganizationMember 2 params → 200400401403404503
POST
/api/v1/user/org/leave
Leave the current organization
leaveUserOrganization 1 param → 200401403404409503
GET
/api/v1/user/persona
Current persona config + available list
getUserPersona → 200401
POST
/api/v1/user/persona
Set personaprimary
postUserPersona 1 param body → 200400401403
GET
/api/v1/user/segments
List user segments
getUserSegments 2 params → 200400422401
POST
/api/v1/user/segments
Create segment
postUserSegments 1 param body → 201400422401
GET
/api/v1/user/segments/{id}
Get segment
getUserSegmentsById 1 param → 200404
PUT
/api/v1/user/segments/{id}
Replace mutable segment fields
putUserSegmentsById 2 params body → 200400422401403404
PATCH
/api/v1/user/segments/{id}
Patch mutable segment fields
patchUserSegmentsById 2 params body → 200400422401403404
DELETE
/api/v1/user/segments/{id}
Delete segment
deleteUserSegmentsById 2 params → 200401403
POST
/api/v1/user/segments/{id}/pin
Toggle pin
postUserSegmentsByIdPin 2 params → 200401403404
POST
/api/v1/user/segments/{id}/run
Execute segment filters → companies
postUserSegmentsByIdRun 3 params → 200400422401403404503
GET
/api/v1/user/lists
List user lists
getUserLists → 200
POST
/api/v1/user/lists
Create list
postUserLists 1 param body → 201400401403
GET
/api/v1/user/lists/{id}
Get list + items
getUserListsById 1 param → 200
PUT
/api/v1/user/lists/{id}
Replace mutable list fields
putUserListsById 2 params body → 200400401403404
PATCH
/api/v1/user/lists/{id}
Patch mutable list fields
patchUserListsById 2 params body → 200400401403404
DELETE
/api/v1/user/lists/{id}
Delete list and its items
deleteUserListsById 2 params → 200401403
POST
/api/v1/user/lists/{id}/items
Add item to list
postUserListsByIdItems 2 params body → 201400401403404
DELETE
/api/v1/user/lists/{id}/items/{item_id}
Remove item from list
deleteUserListsByIdItemsByItemId 3 params → 200401403404
GET
/api/v1/user/notes
Recent notes
getUserNotes 1 param → 200400422401
POST
/api/v1/user/notes
Create private note
postUserNotes 1 param body → 201400401403
GET
/api/v1/user/notes/{id}
Get note
getUserNotesById 1 param → 200
PUT
/api/v1/user/notes/{id}
Replace mutable note fields
putUserNotesById 2 params body → 200400401403404
PATCH
/api/v1/user/notes/{id}
Patch mutable note fields
patchUserNotesById 2 params body → 200400401403404
DELETE
/api/v1/user/notes/{id}
Delete note
deleteUserNotesById 2 params → 200401403
GET
/api/v1/user/notes/for/{type}/{id}
Notes for a target
getUserNotesForByTypeById 2 params → 200
GET
/api/v1/user/tags
List user tags with counts
getUserTags → 200
POST
/api/v1/user/tags
Create tag
postUserTags 1 param body → 201400401403
DELETE
/api/v1/user/tags/{id}
Delete tag and assignments
deleteUserTagsById 2 params → 200401403
POST
/api/v1/user/tags/{id}/assign
Assign tag to target
postUserTagsByIdAssign 2 params body → 200400401403404
POST
/api/v1/user/tags/{id}/unassign
Unassign tag from target
postUserTagsByIdUnassign 2 params body → 200400401403404
GET
/api/v1/user/exports
Export history + monthly usage
getUserExports 1 param → 200400422401
GET
/api/v1/user/exports/usage
Monthly export quota usage only
getUserExportsUsage → 200
GET
/api/v1/user/audit
Audit log (MAX/Enterprise only)
getUserAudit 2 params → 200400422401402
POST
/api/v1/persons/lookup
Run an authenticated KYC documentary lookup
lookupPersonByDni 1 param body → 200400401402403429503
GET
/api/v1/persons/lookup/usage
Get the caller's KYC lookup allowance and usage
getPersonLookupUsage → 200401503
GET
/api/v1/persons/lookup/history
Get the caller's redacted KYC lookup history
getPersonLookupHistory 2 params → 200400422401402503
GET
/api/v1/user/api-credentials
List API credential metadata
listUserApiCredentials 2 params → 200400422401503
POST
/api/v1/user/api-credentials
Create an API credential
createUserApiCredential 2 params body → 201400401403409429503
POST
/api/v1/user/api-credentials/{id}/rotate
Rotate one API credential
rotateUserApiCredential 3 params body → 200400401403404409429503
DELETE
/api/v1/user/api-credentials/{id}
Revoke one API credential
revokeUserApiCredential 2 params → 200401403404429503
GET
/api/v1/user/webhooks
List outbound webhook metadata
listUserWebhooks → 200401503
POST
/api/v1/user/webhooks
Create an outbound webhook
createUserWebhook 2 params body → 201400401403409429503
PATCH
/api/v1/user/webhooks/{id}
Update an outbound webhook
updateUserWebhook 2 params body → 200400401403404429503
DELETE
/api/v1/user/webhooks/{id}
Delete an outbound webhook
deleteUserWebhook 2 params → 200401403404429503
POST
/api/v1/user/webhooks/{id}/rotate
Rotate an outbound webhook signing secret
rotateUserWebhookSecret 3 params → 200400401403404409429503
POST
/api/v1/support/ticket/{id}/reply
Reply to a support ticket owned by the authenticated user
replySupportTicket 2 params body → 200400401403413429503
GET
/api/v1/csrf
Get a live same-origin CSRF token
getCsrfToken → 200
POST
/api/v1/resend-verification
Resend the account email-verification link
postResendVerification 1 param → 200401403429502
POST
/api/v1/credits/checkout
Create an idempotent credit-pack Checkout session
postCreditsCheckout 2 params body → 200400401403413429503
POST
/api/v1/empresa/{slug}/informe-legal
Create the authenticated user's redacted corporate legal report
createCompanyLegalReport 2 params body → 200400401402403404413429
POST
/api/v1/checkout
Create a subscription Checkout session
postSubscriptionCheckout 2 params body → 200400401413429503403
GET
/api/v1/billing/invoices
List the authenticated user's invoices and subscription
getBillingInvoices → 200401429
GET
/api/v1/billing/portal
Redirect to the authenticated user's Stripe portal
getBillingPortal → 302400401429503
POST
/api/v1/billing/portal
Create a Stripe portal session as JSON
postBillingPortal 1 param → 200400401403429503
POST
/api/v1/portaldeprecated
Create a Stripe Customer Portal session through the legacy alias
postLegacyBillingPortal 1 param body → 200400401403429503

Schemas 89

The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (35 properties), BillingInvoice (16 properties), KycPersonLookupResponse (16 properties), LegalReportAxis (15 properties). Each schema is shown below with its type and property counts.

LegalReportResponse
object
7 properties 7 required
StripeSessionResponse
object
2 properties 2 required
UserSegmentStoredFilters
object
Read-only decoded filtersjson from an existing segment. New writes must use UserSegmentFilters. Historic records may still contain removed keys such as forma o…
EmailDispatchResponse
object
2 properties 2 required
OutboundWebhookEventTypeV1
string
Exact subscription allowlist for webhook payload contract 1.0. Unknown event types, wildcard subscriptions and unsupported schema versions fail closed. Adding…
PersonaOption
object
4 properties 4 required
UserSegmentRunResponse
object
4 properties 4 required
OutboundWebhookOneTimeResponse
object
5 properties 5 required
LegalReportPaymentRequiredError
OrganizationMember
object
4 properties 4 required
UserListListResponse
object
3 properties 3 required
OrganizationCreatedResponse
object
2 properties 2 required
UserOrganizationInviteRequest
object
2 properties 1 required
VerificationDispatchResponse
object
2 properties 2 required
WebhookWorkerHealth
object
4 properties 3 required
UserTagCreatedResponse
object
2 properties 2 required
OutboundWebhookEventCatalogV1
Exact account-visible list of events with a currently wired durable producer.
UserSegmentCreateRequest
object
6 properties 2 required
BillingSubscription
object
Authenticated user's current subscription metadata.
14 properties
SupportErrorResponse
object
4 properties 2 required
UserSegment
object
Saved account segment. Extra migration columns may be returned for backward compatibility.
11 properties
ApiCredential
object
13 properties 8 required
CredentialRevokedResponse
object
2 properties 2 required
BillingInvoicesResponse
object
3 properties 3 required
OutboundWebhookContractedEventTypeV1
string
Versioned event names with a defined payload contract. Only names also present in OutboundWebhookEventTypeV1 are currently subscribable.
UserListDetail
LegalReportDocument
object
3 properties 3 required
UserSegmentListResponse
object
3 properties 3 required
OutboundWebhookUpdateRequest
object
3 properties
JsonValue
A JSON value used only inside explicitly documented extension maps.
UserNote
object
Private note visible only to its authenticated owner.
9 properties
OrganizationInviteCreatedResponse
object
7 properties 7 required
UserNotesForTargetResponse
object
2 properties 2 required
KycPersonLookupRequest
object
2 properties 2 required
UserPersonaSelectedResponse
object
2 properties 2 required
UserSegmentFilters
object
Corporate-only filters executed exclusively over the immutable companypublicv2 sidecar. At least one effective anchor is required: provincia, cnaeprefix, a cap…
8 properties
UserOrganizationResponse
object
5 properties
LegalReportAxis
object
One documentary axis in the redacted corporate legal-history projection. Presence records sourced events; it does not assert wrongdoing, solvency, current stat…
15 properties 4 required
UserNoteListResponse
object
2 properties 2 required
CompanySearchItem
object
12 properties 4 required
BillingInvoice
object
Authenticated user's invoice metadata; URLs point to Stripe-hosted documents.
16 properties
UserOrganizationMemberRoleRequest
object
1 property 1 required
KycPersonLookupResults
object
3 properties 3 required
DeletedResponse
object
2 properties 2 required
LegalReportRequest
object
The body carries only the CSRF fallback. Entitlement, pricing, beta status and the daily idempotency key are server-owned.
1 property
UserTagAssignmentRequest
object
2 properties 2 required
UserListItem
object
Saved list item owned by the authenticated account.
6 properties
RequestBodyTooLargeError
object
2 properties 2 required
ErrorResponse
object
Closed compatibility envelope for public/account errors. Route-specific schemas narrow these fields further where required.
35 properties 1 required
UserAuditEntry
object
Account audit entry. Sensitive metadata is not part of the public contract.
5 properties
UserPersonaUpdateRequest
object
1 property 1 required
UserSegmentPinResponse
object
1 property 1 required
OutboundWebhookContractedEventCatalogV1
array
All event payload contracts known by this API version, including contracted-but-unwired events that cannot yet be subscribed.
ApiCredentialCreateRequest
object
3 properties 1 required
ApiCredentialRotateRequest
object
3 properties
SupportReplyRequest
object
1 property 1 required
UserNoteUpdateRequest
object
3 properties
UserExportRecord
object
Authenticated user's export history metadata.
5 properties
UserNoteCreateRequest
object
5 properties 3 required
UserListCreatedResponse
object
2 properties 2 required
UserTagListResponse
object
3 properties 3 required
UserTagCreateRequest
object
2 properties 1 required
UserExportListResponse
object
2 properties 2 required
UserListUpdateRequest
object
4 properties
UserOrganizationNameRequest
object
1 property 1 required
OrganizationInvite
object
5 properties 5 required
KycPersonLookupResponse
object
16 properties 3 required
KycPersonLookupHistoryResponse
object
4 properties 4 required
ApiCredentialOneTimeResponse
object
7 properties 6 required
SupportRequestErrorResponse
Support validation/ownership errors carry ok=false; shared body-reader and action-budget errors use the generic API error envelope.
UserSegmentUpdateRequest
object
5 properties
KycUsage
object
5 properties 5 required
UserNoteCreatedResponse
object
2 properties 2 required
OutboundWebhookCreateRequest
object
2 properties 2 required
ExportUsageResponse
object
5 properties 5 required
WebhookUpdatedResponse
object
2 properties 2 required
UserSegmentCreatedResponse
object
2 properties 2 required
UserList
object
Saved user list; migration columns may be appended.
9 properties
OkResponse
object
1 property 1 required
UserAuditResponse
object
2 properties 2 required
KycPersonLookupUsageResponse
object
5 properties 1 required
UserPersonaResponse
object
3 properties 3 required
UserListItemCreateRequest
object
3 properties 2 required
UserListCreateRequest
object
4 properties 1 required
UserTag
object
Private account tag and optional aggregate usage count.
6 properties
OutboundWebhook
object
9 properties 6 required
UserMeResponse
object
7 properties 4 required
KycLookupHistoryEntry
object
9 properties 8 required
OutboundWebhookEventSubscriptionsV1
array
Events with a currently wired durable producer. Contracted-but-unwired event types are not subscribable. An empty input is normalized to alert.triggered; wildc…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmercantil-user-api-openapi.yml Raw ↑

Other APIs OpenMercantil publishes across the network.

OpenMercantil API Credentials API
AE Profile APIs.io
OpenMercantil Billing API
AE Profile APIs.io
OpenMercantil BORME API
AE Profile APIs.io
OpenMercantil Companies API
AE Profile APIs.io
OpenMercantil Datasets API
AE Profile APIs.io
OpenMercantil Graph API
AE Profile APIs.io
OpenMercantil Integrations API
AE Profile APIs.io
OpenMercantil Legal API
AE Profile APIs.io
OpenMercantil Persons API
AE Profile APIs.io
OpenMercantil Public Procurement API
AE Profile APIs.io
OpenMercantil Search API
AE Profile APIs.io
OpenMercantil Sectors API
AE Profile APIs.io
#User
← Back to O APIs
API Details
ID
openmercantil:openmercantil-user-api
Server
https://openmercantil.es
Docs
https://openmercantil.es/api/documentacion
Provider
OpenMercantil
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openmercantil-user-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openmercantil-user-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OpenMercantil User 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.