Skip to main content
API docs by Redocly

GAAS (1.0.0)

Download OpenAPI specification:Download

GAAS API

Session

Creating and updating sessions for data collection

Create

Creates a session associated with the nif/nie and initiates the authentication process against the AEAT/DGT
Note: The session will be valid for 5 minutes.

Authorizations:
apiKeyHeaderapiKeyQuery
query Parameters
externalId
required
string (ExternalIdParams)

ExternalId identifier

Request Body schema: application/json
challengeMethod
string (CHALLENGE_METHOD)
Enum: "CLAVE_MOVIL" "APP" "SMS"
validationDate
required
string <dd-MM-yyyy>

with NIF (Número Identificación Fiscal): Date of validity of the identification document with NIE (Número Identificación Extranjero): Date of birth of the holder

supportNumber
string^[0-9]{7}[A-Za-z]{1}$

NIE support number (obligatory if NIE is provided)

nie
string^[XYZ]{1}[0-9]{7}[A-Za-z]{1}$

NIE (Número Identificación Extranjero): NIE of the holder

nif
string^[0-9]{8}[A-Za-z]{1}$

NIF (Número Identificación Fiscal): NIF of the holder

agency
string (AGENCY)
Enum: "AEAT" "DGT"

Responses

Request samples

Content type
application/json
{
  • "challengeMethod": "CLAVE_MOVIL",
  • "validationDate": "string",
  • "supportNumber": "string",
  • "nie": "string",
  • "nif": "string",
  • "agency": "AEAT"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Sandbox Configuration

When the apikey is configured for Sandbox mode then this request returns a list of the datasets availables for the sandbox.

Authorizations:
apiKeyHeaderapiKeyQuery
query Parameters
externalId
required
string (ExternalIdParams)

ExternalId identifier

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update

Request to update the pin of a credential in order to complete the authentication process against the AEAT

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
sessionId
required
string <uuid> (SessionIdentifierParams)

Session identifier

query Parameters
externalId
required
string (ExternalIdParams)

ExternalId identifier

Request Body schema: application/json
pin
required
string = 3 characters ^[a-zA-Z0-9]+$

Pin received from the application or by sms

agency
string (AGENCY)
Enum: "AEAT" "DGT"

Responses

Request samples

Content type
application/json
{
  • "pin": "str",
  • "agency": "AEAT"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Validate

Request to validate a credential in order to complete the authentication process against the AEAT

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
sessionId
required
string <uuid> (SessionIdentifierParams)

Session identifier

query Parameters
agency
required
string (AgencyParams)
Enum: "AEAT" "DGT"
externalId
required
string (ExternalIdParams)

ExternalId identifier

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Aeat

Information is returned from the AEAT for the sessions provided

GetDocument

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
sessionId
required
string <uuid> (SessionIdentifierParams)

Session identifier

query Parameters
externalId
required
string (ExternalIdParams)

ExternalId identifier

documentType
required
string (DocumentTypeParams)
Enum: "debtCertificate" "txt" "xml"
taxYear
string (TaxYearQueryParam)
Enum: "2020" "2021" "2022" "2023"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieve

This request returns the tax information of the indicated session by extracting the information from the XML submitted to the AEAT for the selected year.
Note: the information obtained from the XML is only that required by the client configured for the apiKey provided. Note: client can have the API mode configured to return the response in JSON, or in REDIRECT mode, which returns a redirection that must be on a whitelist provided by the client and must be passed through the "redirectUrl" querystring."

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
sessionId
required
string <uuid> (SessionIdentifierParams)

Session identifier

query Parameters
taxYear
required
string (TaxYearQueryParam)
Enum: "2020" "2021" "2022" "2023"
externalId
required
string (ExternalIdParams)

ExternalId identifier

redirectUrl
string (RedirectUrlParams)

Redirect URL

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Reference

This request returns the reference of the user for the AEAT service

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
sessionId
required
string <uuid> (SessionIdentifierParams)

Session identifier

query Parameters
externalId
required
string (ExternalIdParams)

ExternalId identifier

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dgt

Retrieve

This request returns the vehicles information of the indicated session by extracting the information from DGT.
Note: the information obtained from DGT is only that required by the client configured for the apiKey provided. Note: client can have the API mode configured to return the response in JSON, or in REDIRECT mode, which returns a redirection that must be on a whitelist provided by the client and must be passed through the "redirectUrl" querystring."

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
sessionId
required
string <uuid> (SessionIdentifierParams)

Session identifier

query Parameters
externalId
required
string (ExternalIdParams)

ExternalId identifier

redirectUrl
string (RedirectUrlParams)

Redirect URL

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}