1. SubClients
Firma Virtual México - Clientes API
  • API
    • OAuth2
      • tokenExchange
      • getAuthorizationServerInfo
      • authMe
    • IntegrationMarketplace
      • marketplaceSetup
      • marketplaceProvision
      • marketplaceAuthorize
    • Documents
      • createDocument
      • getAllDocumentsByMe
      • getDocumentByIdAndMe
      • getDocumentStatisticsByMe
    • Files
      • uploadBiometryFiles
      • downloadByFileName
      • downloadBiometryMedia
    • Signatures
      • signDocument
    • SignatureCreditAccount
      • getSignatureCreditAccountByMe
    • SignatureCreditAccountMovement
      • getAllSignatureCreditAccountMovementsByMe
      • getSignatureCreditAccountMovementByIdAndMe
    • PurchaseOrder
      • getAllPurchasesByMe
    • SignaturePackages
      • getAllPackages
    • Mails
      • forwardBiometricValidation
    • SubUsers
      • getAllSubusersByMe
      • createSubuserByMe
    • SubClients
      • getAllSubclientsByMe
        GET
      • createSubclientByMe
        POST
  1. SubClients

createSubclientByMe

POST
https://demo-apimex.firmavirtual.mx/api/oauth2/integration/clients/subclients/create

createSubclientByMe#

Endpoint que permite al cliente autenticado crear un nuevo subcliente, proporcionando su nombre, RFC y descripción, junto con los datos del contacto principal (nombre, RFC, correo, teléfono, CURP) y la política (policy) que definirá sus límites, como la posibilidad de crear subusuarios o subclientes propios.
URL: /api/oauth2/integration/clients/subclients/create
METHOD: POST
HEADERS:
ClaveTipoRequeridoDescripción
AuthorizationstringSíToken de acceso en el formato Bearer {access_token}.
X-Client-App-UUIDstringSíUUID de la aplicación de integración asociada al token de acceso.
BODY:
ClaveTipoRequeridoDescripción
namestringSíNombre del subcliente o empresa.
rfcstringSíRFC del subcliente o empresa.
descriptionstringNoDescripción adicional del subcliente.
contact.rfcstringSíRFC del contacto principal del subcliente.
contact.first_namestringSíNombre(s) del contacto principal.
contact.last_namestringSíApellido paterno del contacto principal.
contact.mother_last_namestringNoApellido materno del contacto principal.
contact.emailstringSíCorreo electrónico del contacto principal.
contact.phonestringNoTeléfono del contacto principal.
contact.curpstringNoCURP del contacto principal.
policy.allow_sub_usersbooleanSíIndica si el subcliente puede crear sus propios subusuarios.
policy.allow_sub_clientsbooleanSíIndica si el subcliente puede crear sus propios subclientes.
policy.allow_api_keysbooleanSíIndica si el subcliente puede generar sus propias API Keys.
policy.allow_appsbooleanSíIndica si el subcliente puede instalar/vincular aplicaciones de integración.
policy.max_sub_usersnumberSíNúmero máximo de subusuarios que el subcliente puede crear.
policy.max_sub_clientsnumberSíNúmero máximo de subclientes que el subcliente puede crear.
policy.max_api_keysnumberSíNúmero máximo de API Keys que el subcliente puede generar.
policy.max_appsnumberSíNúmero máximo de aplicaciones de integración que el subcliente puede vincular.
policy.can_deactivate_sub_usersbooleanSíIndica si el subcliente puede desactivar a sus subusuarios.
policy.can_deactivate_sub_clientsbooleanSíIndica si el subcliente puede desactivar a sus subclientes.
policy.can_manage_creditsbooleanSíIndica si el subcliente puede administrar créditos de firma (asignarlos a sus subusuarios/subclientes).
policy.can_buy_creditsbooleanSíIndica si el subcliente puede comprar créditos de firma.
policy.max_credits_per_assignnumberSíCantidad máxima de créditos que el subcliente puede asignar en una sola operación.
policy.can_sub_user_buy_creditsbooleanSíIndica si los subusuarios del subcliente pueden comprar créditos de firma.
policy.can_sub_client_buy_creditsbooleanSíIndica si los subclientes del subcliente pueden comprar créditos de firma.
policy.allowed_package_typestringSíTipo de paquete permitido para el subcliente, p. ej. BASE.
Body Parameters
{
  "name": "",
  "rfc": "",
  "description": "",
  "contact": {
    "rfc": "",
    "first_name": "",
    "last_name": "",
    "mother_last_name": "",
    "email": "",
    "phone": "",
    "curp": ""
  },
  "policy": {
    "allow_sub_users": true,
    "allow_sub_clients": true,
    "allow_api_keys": true,
    "allow_apps": true,
    "max_sub_users": 0,
    "max_sub_clients": 0,
    "max_api_keys": 0,
    "max_apps": 0,
    "can_deactivate_sub_users": false,
    "can_deactivate_sub_clients": false,
    "can_manage_credits": true,
    "can_buy_credits": true,
    "max_credits_per_assign": 0,
    "can_sub_user_buy_credits": false,
    "can_sub_client_buy_credits": false,
    "allowed_package_type": "BASE"
  }
}
RESPONSE
{}

Solicitud

Parámetros de Header

Parámetros del Body application/jsonRequerido

Ejemplos

Respuestas

🟢200Éxito
application/json
Bodyapplication/json

Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://demo-apimex.firmavirtual.mx/api/oauth2/integration/clients/subclients/create' \
--header 'Content-Type: application/json' \
--data '{
    "name": "",
    "rfc": "", 
    "description": "",
    "contact": {
        "rfc": "",
        "first_name": "",
        "last_name": "",
        "mother_last_name": "",
        "email": "",
        "phone": "",
        "curp": ""
    },
    "policy": {
        "allow_sub_users": true,
        "allow_sub_clients": true,
        "allow_api_keys": true,
        "allow_apps": true,
        "max_sub_users": 0,
        "max_sub_clients": 0,
        "max_api_keys": 0,
        "max_apps": 0,
        "can_deactivate_sub_users": false,
        "can_deactivate_sub_clients": false,
        "can_manage_credits": true,
        "can_buy_credits": true,
        "max_credits_per_assign": 0,
        "can_sub_user_buy_credits": false,
        "can_sub_client_buy_credits": false,
        "allowed_package_type": "BASE"
    }
}'
Respuesta Ejemplo de Respuesta
{}
Modificado en 2026-08-24 20:03:52
Anterior
getAllSubclientsByMe
Built with