API Documentation

Swagger colletion

get
Authorizations
Responses
200

OK

*/*
get
GET /api/v1/subscriptions HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "subscriptionType": "FREE",
    "confirmationCode": "text",
    "paymentStatus": "PENDING",
    "upgradeStatus": "PENDING",
    "subscriptionStatus": "ACTIVE",
    "requestCount": 1,
    "billingCycleEndDate": "2025-10-10",
    "emailConfirmed": true,
    "created_date": "2025-10-10T19:37:12.924Z",
    "last_updated": "2025-10-10T19:37:12.924Z"
  }
]
post
Authorizations
Body
emailstringOptional
subscriptionTypestring · enumOptionalPossible values:
Responses
200

OK

*/*
Responsestring
post
POST /api/v1/subscriptions HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "email": "text",
  "subscriptionType": "FREE"
}
200

OK

text
post
Authorizations
Header parameters
X-Email-TokenstringRequired
Body
otpstringOptional
Responses
200

OK

*/*
Responsestring
post
POST /api/v1/subscriptions/validate-otp HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
X-Email-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "otp": "text"
}
200

OK

text
post
Authorizations
Body
namestringOptional
emailstringOptional
confirmEmailstringOptional
passwordstringOptional
confirmPasswordstringOptional
rolestring · enumOptionalPossible values:
positionstring · enumOptionalPossible values:
Responses
200

OK

*/*
post
POST /api/v1/subscriptions/subscribed HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "name": "text",
  "email": "text",
  "confirmEmail": "text",
  "password": "text",
  "confirmPassword": "text",
  "role": "ADMIN",
  "position": "MANAGER"
}
200

OK

{
  "timeStamp": "2025-10-10T19:37:12.924Z",
  "statusCode": 1,
  "httpStatus": "100 CONTINUE",
  "reason": "text",
  "message": "text",
  "developerMessage": "text",
  "data": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
post
Authorizations
Header parameters
X-Email-TokenstringRequired
Responses
200

OK

*/*
Responsestring
post
POST /api/v1/subscriptions/regenerate-otp HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
X-Email-Token: text
Accept: */*
200

OK

text
post
Authorizations
Query parameters
userIdstringRequired
otpstringRequired
Responses
200

OK

*/*
Responsestring
post
POST /api/v1/otp/validate?userId=text&otp=text HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

text
get
Authorizations
Responses
200

OK

*/*
get
GET /api/v1/organizations HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "organizationType": "FINANCIAL",
    "organizationScope": "LOCAL",
    "organizationStatus": "ACTIVE",
    "taxIdentificationType": "CUIL",
    "taxIdentificationNumber": "text",
    "phoneNumber": "text",
    "country": "text",
    "webhookUrl": "text",
    "websiteUrl": "text",
    "apiKey": "text",
    "enablementStatus": {
      "paymentIssue": true,
      "paymentStatus": "PENDING",
      "legalIssue": true,
      "legalStatus": "CLEAR",
      "revocationIssue": true,
      "revocationStatus": "NOT_REVOKED",
      "dataIntegrityIssue": true,
      "dataIntegrityStatus": "VALID"
    },
    "createdDate": "2025-10-10T19:37:12.924Z",
    "lastUpdateDate": "2025-10-10T19:37:12.924Z"
  }
]
post
Authorizations
Body
namestringOptional
emailstringOptional
countrystringOptional
legalTypestring · enumOptionalPossible values:
websiteUrlstringOptional
taxIdentificationTypestring · enumOptionalPossible values:
taxIdentificationNumberstringOptional
organizationTypestring · enumOptionalPossible values:
organizationScopestring · enumOptionalPossible values:
organizationStatusstring · enumOptionalPossible values:
phoneNumberstringOptional
Responses
200

OK

*/*
Responseobject
post
POST /api/v1/organizations HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "name": "text",
  "email": "text",
  "country": "text",
  "legalType": "PERSON",
  "websiteUrl": "text",
  "taxIdentificationType": "CUIL",
  "taxIdentificationNumber": "text",
  "organizationType": "FINANCIAL",
  "organizationScope": "LOCAL",
  "organizationStatus": "ACTIVE",
  "phoneNumber": "text"
}
200

OK

{}
post
Authorizations
Query parameters
licenseCodestringRequired
Header parameters
requesterEntitystringRequired
X-Api-KeystringOptional
Responses
200

OK

*/*
post
POST /api/v1/licenses/validate?licenseCode=text HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
requesterEntity: text
Accept: */*
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": {}
}
post
Authorizations
Header parameters
X-Api-KeystringOptional
Body
licenseCodestringOptional
senderWebhookUrlstringOptional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
descriptionstringOptional
Responses
200

OK

No content
post
POST /api/v1/licenses/historical-issue HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "licenseCode": "text",
  "senderWebhookUrl": "text",
  "type": "BANNED",
  "status": "OPEN",
  "description": "text"
}
200

OK

No content
post
Authorizations
Body
ownerNamestringOptional
identityNumberstringOptional
emailstringOptional
professionalTypestring · enumOptionalPossible values:
licenseScopestring · enumOptionalPossible values:
licenseCodestringOptional
qualificationstringOptional
formingEntitystringOptional
emissionCountrystringOptional
emissionDatestring · date-timeOptional
renovationDatestring · date-timeOptional
Responses
200

OK

*/*
post
POST /api/v1/licenses/create HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 295

{
  "ownerName": "text",
  "identityNumber": "text",
  "email": "text",
  "professionalType": "ACCOUNTANT",
  "licenseScope": "NATIONAL",
  "licenseCode": "text",
  "qualification": "text",
  "formingEntity": "text",
  "emissionCountry": "text",
  "emissionDate": "2025-10-10T19:37:12.924Z",
  "renovationDate": "2025-10-10T19:37:12.924Z"
}
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "imageId": "text",
  "ownerName": "text",
  "identityNumber": "text",
  "professionalType": "ACCOUNTANT",
  "licenseScope": "NATIONAL",
  "licenseCode": "text",
  "valid": true,
  "emissionDate": "text",
  "renovationDate": "text",
  "expired": true,
  "statusHistory": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "historicalIssues": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "issueType": "BANNED",
        "issueStatus": "OPEN",
        "description": "text",
        "originWebhookUrl": "text",
        "historicalStatus": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "historicalIssues": [
            "[Circular Reference]"
          ],
          "historicalComments": "text",
          "statusDate": "2025-10-10T19:37:12.924Z",
          "created_date": "2025-10-10T19:37:12.924Z",
          "last_updated": "2025-10-10T19:37:12.924Z"
        },
        "created_date": "2025-10-10T19:37:12.924Z",
        "last_updated": "2025-10-10T19:37:12.924Z"
      }
    ],
    "historicalComments": "text",
    "statusDate": "2025-10-10T19:37:12.924Z",
    "created_date": "2025-10-10T19:37:12.924Z",
    "last_updated": "2025-10-10T19:37:12.924Z"
  },
  "requestCount": 1,
  "validationRequests": 1
}
get
Authorizations
Responses
200

OK

*/*
get
GET /api/v1/customers HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "username": "text",
    "email": "text",
    "roles": [
      {
        "roleName": "text",
        "roleCategory": "text",
        "description": "text"
      }
    ],
    "position": "MANAGER",
    "subscription": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "text",
      "subscriptionType": "FREE",
      "confirmationCode": "text",
      "paymentStatus": "PENDING",
      "upgradeStatus": "PENDING",
      "subscriptionStatus": "ACTIVE",
      "requestCount": 1,
      "billingCycleEndDate": "2025-10-10",
      "emailConfirmed": true,
      "created_date": "2025-10-10T19:37:12.924Z",
      "last_updated": "2025-10-10T19:37:12.924Z"
    },
    "accountNonLocked": true,
    "enabled": true
  }
]
post
Authorizations
Body
namestringOptional
emailstringOptional
confirmEmailstringOptional
passwordstringOptional
confirmPasswordstringOptional
rolestring · enumOptionalPossible values:
positionstring · enumOptionalPossible values:
Responses
200

OK

*/*
post
POST /api/v1/customers HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "name": "text",
  "email": "text",
  "confirmEmail": "text",
  "password": "text",
  "confirmPassword": "text",
  "role": "ADMIN",
  "position": "MANAGER"
}
200

OK

{
  "timeStamp": "2025-10-10T19:37:12.924Z",
  "statusCode": 1,
  "httpStatus": "100 CONTINUE",
  "reason": "text",
  "message": "text",
  "developerMessage": "text",
  "data": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
post
Authorizations
Body
usernamestringOptional
passwordstringOptional
Responses
200

OK

*/*
post
POST /api/v1/auth/login HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "username": "text",
  "password": "text"
}
200

OK

{
  "token": "text",
  "customerDTO": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "username": "text",
    "email": "text",
    "roles": [
      {
        "roleName": "text",
        "roleCategory": "text",
        "description": "text"
      }
    ],
    "position": "MANAGER",
    "subscription": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "text",
      "subscriptionType": "FREE",
      "confirmationCode": "text",
      "paymentStatus": "PENDING",
      "upgradeStatus": "PENDING",
      "subscriptionStatus": "ACTIVE",
      "requestCount": 1,
      "billingCycleEndDate": "2025-10-10",
      "emailConfirmed": true,
      "created_date": "2025-10-10T19:37:12.924Z",
      "last_updated": "2025-10-10T19:37:12.924Z"
    },
    "accountNonLocked": true,
    "enabled": true
  }
}
get
Authorizations
Query parameters
userIdstringRequired
Responses
200

OK

*/*
Responsestring
get
GET /api/v1/otp/generate?userId=text HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

text
get
Authorizations
Path parameters
idstring · uuidRequired
Responses
200

OK

*/*
get
GET /api/v1/organizations/{id} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "email": "text",
  "organizationType": "FINANCIAL",
  "organizationScope": "LOCAL",
  "organizationStatus": "ACTIVE",
  "legalData": {
    "id": 1,
    "name": "text",
    "email": "text",
    "gender": "MALE",
    "legalType": "PERSON",
    "identificationType": "DNI",
    "identificationNumber": "text",
    "taxIdentificationType": "CUIL",
    "taxIdentificationNumber": "text",
    "birthDate": "2025-10-10",
    "nationality": "text",
    "address": {
      "street": "text",
      "number": "text",
      "city": "text",
      "state": "text",
      "country": "text",
      "cp": 1
    },
    "phoneNumber": "text",
    "created_date": "2025-10-10T19:37:12.924Z",
    "last_updated": "2025-10-10T19:37:12.924Z"
  },
  "webhookUrl": "text",
  "websiteUrl": "text",
  "apiKey": "text",
  "enablementStatus": {
    "paymentIssue": true,
    "paymentStatus": "PENDING",
    "legalIssue": true,
    "legalStatus": "CLEAR",
    "revocationIssue": true,
    "revocationStatus": "NOT_REVOKED",
    "dataIntegrityIssue": true,
    "dataIntegrityStatus": "VALID"
  },
  "created_date": "2025-10-10T19:37:12.924Z",
  "last_updated": "2025-10-10T19:37:12.924Z"
}
get
Authorizations
Query parameters
namestringRequired
Header parameters
X-Api-KeystringOptional
Responses
200

OK

*/*
get
GET /api/v1/organizations/external/organization?name=text HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "email": "text",
  "organizationType": "FINANCIAL",
  "organizationScope": "LOCAL",
  "organizationStatus": "ACTIVE",
  "legalData": {
    "id": 1,
    "name": "text",
    "email": "text",
    "gender": "MALE",
    "legalType": "PERSON",
    "identificationType": "DNI",
    "identificationNumber": "text",
    "taxIdentificationType": "CUIL",
    "taxIdentificationNumber": "text",
    "birthDate": "2025-10-10",
    "nationality": "text",
    "address": {
      "street": "text",
      "number": "text",
      "city": "text",
      "state": "text",
      "country": "text",
      "cp": 1
    },
    "phoneNumber": "text",
    "created_date": "2025-10-10T19:37:12.924Z",
    "last_updated": "2025-10-10T19:37:12.924Z"
  },
  "webhookUrl": "text",
  "websiteUrl": "text",
  "apiKey": "text",
  "enablementStatus": {
    "paymentIssue": true,
    "paymentStatus": "PENDING",
    "legalIssue": true,
    "legalStatus": "CLEAR",
    "revocationIssue": true,
    "revocationStatus": "NOT_REVOKED",
    "dataIntegrityIssue": true,
    "dataIntegrityStatus": "VALID"
  },
  "created_date": "2025-10-10T19:37:12.924Z",
  "last_updated": "2025-10-10T19:37:12.924Z"
}
get
Authorizations
Responses
200

OK

*/*
get
GET /api/v1/licenses HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "imageId": "text",
    "ownerName": "text",
    "identityNumber": "text",
    "professionalType": "ACCOUNTANT",
    "licenseScope": "NATIONAL",
    "licenseCode": "text",
    "valid": true,
    "emissionDate": "text",
    "renovationDate": "text",
    "expired": true,
    "statusHistory": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "historicalIssues": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "issueType": "BANNED",
          "issueStatus": "OPEN",
          "description": "text",
          "originWebhookUrl": "text",
          "historicalStatus": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "historicalIssues": "[Circular Reference]",
            "historicalComments": "text",
            "statusDate": "2025-10-10T19:37:12.924Z",
            "created_date": "2025-10-10T19:37:12.924Z",
            "last_updated": "2025-10-10T19:37:12.924Z"
          },
          "created_date": "2025-10-10T19:37:12.924Z",
          "last_updated": "2025-10-10T19:37:12.924Z"
        }
      ],
      "historicalComments": "text",
      "statusDate": "2025-10-10T19:37:12.924Z",
      "created_date": "2025-10-10T19:37:12.924Z",
      "last_updated": "2025-10-10T19:37:12.924Z"
    },
    "requestCount": 1,
    "validationRequests": 1
  }
]
get
Authorizations
Path parameters
idstring · uuidRequired
Responses
200

OK

*/*
get
GET /api/v1/licenses/{id} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "licenseOwner": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "email": "text",
    "identityNumber": "text",
    "imageId": "text",
    "legalData": {
      "id": 1,
      "name": "text",
      "email": "text",
      "gender": "MALE",
      "legalType": "PERSON",
      "identificationType": "DNI",
      "identificationNumber": "text",
      "taxIdentificationType": "CUIL",
      "taxIdentificationNumber": "text",
      "birthDate": "2025-10-10",
      "nationality": "text",
      "address": {
        "street": "text",
        "number": "text",
        "city": "text",
        "state": "text",
        "country": "text",
        "cp": 1
      },
      "phoneNumber": "text",
      "created_date": "2025-10-10T19:37:12.924Z",
      "last_updated": "2025-10-10T19:37:12.924Z"
    },
    "enablementStatus": {
      "paymentIssue": true,
      "paymentStatus": "PENDING",
      "legalIssue": true,
      "legalStatus": "CLEAR",
      "revocationIssue": true,
      "revocationStatus": "NOT_REVOKED",
      "dataIntegrityIssue": true,
      "dataIntegrityStatus": "VALID"
    }
  },
  "professionalType": "ACCOUNTANT",
  "licenseScope": "NATIONAL",
  "licenseCode": "text",
  "valid": true,
  "qualification": "text",
  "formingEntity": "text",
  "emissionCountry": "text",
  "emissionDate": "2025-10-10T19:37:12.924Z",
  "renovationDate": "2025-10-10T19:37:12.924Z",
  "expired": true,
  "historicalStatus": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "historicalIssues": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "issueType": "BANNED",
        "issueStatus": "OPEN",
        "description": "text",
        "originWebhookUrl": "text",
        "historicalStatus": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "historicalIssues": [
            "[Circular Reference]"
          ],
          "historicalComments": "text",
          "statusDate": "2025-10-10T19:37:12.924Z",
          "created_date": "2025-10-10T19:37:12.924Z",
          "last_updated": "2025-10-10T19:37:12.924Z"
        },
        "created_date": "2025-10-10T19:37:12.924Z",
        "last_updated": "2025-10-10T19:37:12.924Z"
      }
    ],
    "historicalComments": "text",
    "statusDate": "2025-10-10T19:37:12.924Z",
    "created_date": "2025-10-10T19:37:12.924Z",
    "last_updated": "2025-10-10T19:37:12.924Z"
  },
  "requestCount": 1,
  "validationRequests": [
    {
      "id": "text",
      "requestDate": "2025-10-10T19:37:12.924Z",
      "requestStatus": "text",
      "requesterUrl": "text",
      "requesterIp": "text",
      "requesterEntity": "text"
    }
  ],
  "statusHistory": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "historicalIssues": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "issueType": "BANNED",
        "issueStatus": "OPEN",
        "description": "text",
        "originWebhookUrl": "text",
        "historicalStatus": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "historicalIssues": [
            "[Circular Reference]"
          ],
          "historicalComments": "text",
          "statusDate": "2025-10-10T19:37:12.924Z",
          "created_date": "2025-10-10T19:37:12.924Z",
          "last_updated": "2025-10-10T19:37:12.924Z"
        },
        "created_date": "2025-10-10T19:37:12.924Z",
        "last_updated": "2025-10-10T19:37:12.924Z"
      }
    ],
    "historicalComments": "text",
    "statusDate": "2025-10-10T19:37:12.924Z",
    "created_date": "2025-10-10T19:37:12.924Z",
    "last_updated": "2025-10-10T19:37:12.924Z"
  },
  "created_date": "2025-10-10T19:37:12.924Z",
  "last_updated": "2025-10-10T19:37:12.924Z"
}
get
Authorizations
Query parameters
licenseCodestringRequired
Header parameters
X-Api-KeystringOptional
Responses
200

OK

*/*
get
GET /api/v1/licenses/license?licenseCode=text HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": {}
}
get
Authorizations
Path parameters
licenseCodestringRequired
Responses
200

OK

*/*
get
GET /api/v1/licenses/external/license/{licenseCode} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "ownerName": "text",
  "professionalType": "ACCOUNTANT",
  "licenseScope": "text",
  "licenseCode": "text",
  "valid": true,
  "expired": true
}
get
Authorizations
Path parameters
customIdstring · uuidRequired
Responses
200

OK

*/*
get
GET /api/v1/customers/{customId} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "username": "text",
  "email": "text",
  "roles": [
    {
      "roleName": "text",
      "roleCategory": "text",
      "description": "text"
    }
  ],
  "position": "MANAGER",
  "subscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "subscriptionType": "FREE",
    "confirmationCode": "text",
    "paymentStatus": "PENDING",
    "upgradeStatus": "PENDING",
    "subscriptionStatus": "ACTIVE",
    "requestCount": 1,
    "billingCycleEndDate": "2025-10-10",
    "emailConfirmed": true,
    "created_date": "2025-10-10T19:37:12.924Z",
    "last_updated": "2025-10-10T19:37:12.924Z"
  },
  "accountNonLocked": true,
  "enabled": true
}
PreviousCommon data

Last updated