"description":"Access account metadata.\n\nInformation about the account record, such as the processing status and IBAN.\n\nAccount status is recalculated based on the error count in the latest req.",
"parameters":[
{
"in":"path",
"name":"id",
"schema":{
"type":"string"
},
"required":true
}
],
"tags":[
"accounts"
],
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Account"
}
}
},
"description":"Sample account metadata"
},
"404":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NotFoundError":{
"value":{
"detail":"Not found.",
"summary":"Not found.",
"status_code":404
},
"summary":"Not found error",
"description":"Not found error"
},
"AccountNotFoundError":{
"value":{
"summary":"Account ID $ACC_ID not found",
"detail":"Please check whether you specified a valid Account ID",
"status_code":404
},
"summary":"Account not found error",
"description":"Account not found"
}
}
}
},
"description":"Account not found"
},
"429":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NordigenRateLimitExceeded":{
"value":{
"summary":"Rate limit exceeded",
"detail":"The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds",
"status_code":429
},
"summary":"Nordigen rate limit exceeded",
"description":"Nordigen rate limit exceeded"
}
}
}
},
"description":"Nordigen rate limit exceeded"
},
"401":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidToken":{
"value":{
"summary":"Invalid token",
"detail":"Token is invalid or expired",
"status_code":401
},
"summary":"Invalid token",
"description":"Token is invalid or expired"
}
}
}
},
"description":"Token is invalid or expired"
},
"403":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"IPAccessDenied":{
"value":{
"summary":"IP address access denied",
"detail":"Your IP $IP_ADDRESS isn't whitelisted to perform this action",
"status_code":403
},
"summary":"IP Access denied",
"description":"IP address not whitelisted"
}
}
}
},
"description":"IP address not whitelisted"
}
}
}
},
"/api/v2/accounts/{id}/balances/":{
"get":{
"operationId":"retrieve account balances",
"description":"Access account balances.\n\nBalances will be returned in Berlin Group PSD2 format.",
"parameters":[
{
"in":"path",
"name":"id",
"schema":{
"type":"string"
},
"required":true
}
],
"tags":[
"accounts"
],
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AccountBalance"
},
"examples":{
"RetrieveAccountBalances":{
"value":{
"balances":[
{
"balanceAmount":{
"amount":"657.49",
"currency":"string"
},
"balanceType":"string",
"referenceDate":"2021-11-22"
},
{
"balanceAmount":{
"amount":"185.67",
"currency":"string"
},
"balanceType":"string",
"referenceDate":"2021-11-19"
}
]
},
"summary":"Account balances",
"description":"Sample account balances"
}
}
}
},
"description":"Sample account balances"
},
"404":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NotFoundError":{
"value":{
"detail":"Not found.",
"summary":"Not found.",
"status_code":404
},
"summary":"Not found error",
"description":"Not found error"
},
"AccountNotFoundError":{
"value":{
"summary":"Account ID $ACC_ID not found",
"detail":"Please check whether you specified a valid Account ID",
"status_code":404
},
"summary":"Account not found error",
"description":"Account not found"
}
}
}
},
"description":"Account not found"
},
"429":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NordigenRateLimitExceeded":{
"value":{
"summary":"Rate limit exceeded",
"detail":"The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds",
"status_code":429
},
"summary":"Nordigen rate limit exceeded",
"description":"Nordigen rate limit exceeded"
},
"RateLimitError":{
"value":{
"summary":"Couldn't update account balances",
"detail":"Daily request limit set by the Institution has been exceeded.",
"type":"RateLimitError",
"status_code":429
},
"summary":"Rate Limit Error",
"description":"RateLimitError"
}
}
}
},
"description":"RateLimitError"
},
"401":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidToken":{
"value":{
"summary":"Invalid token",
"detail":"Token is invalid or expired",
"status_code":401
},
"summary":"Invalid token",
"description":"Token is invalid or expired"
},
"AccessExpiredError":{
"value":{
"summary":"Couldn't update account balances",
"detail":"Access has expired or it has been revoked. To restore access reconnect the account.",
"type":"AccessExpiredError",
"status_code":401
},
"summary":"Access Expired Error",
"description":"AccessExpiredError"
},
"AccountInactiveError":{
"value":{
"summary":"Couldn't update account balances",
"detail":"Account has been deactivated or it no longer exists.",
"type":"AccountInactiveError",
"status_code":401
},
"summary":"Account Inactive Error",
"description":"AccountInactiveError"
}
}
}
},
"description":"AccountInactiveError"
},
"403":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"IPAccessDenied":{
"value":{
"summary":"IP address access denied",
"detail":"Your IP $IP_ADDRESS isn't whitelisted to perform this action",
"status_code":403
},
"summary":"IP Access denied",
"description":"IP address not whitelisted"
},
"AccountEUAScopeError":{
"value":{
"summary":"End User Agreement (EUA) access scope error",
"detail":"EUA doesn't allow access to account balances. Check EUA access scope. Or create new EUA with correct access scope",
"status_code":403
},
"summary":"Account EUA scope error",
"description":"EUA doesn't allow access to account balances."
},
"AccountValidEUAError":{
"value":{
"summary":"No valid End User Agreement",
"detail":"Account exists but there is no valid End User Agreement permitting you to access it",
"status_code":403
},
"summary":"Account valid EUA error",
"description":"Account has no valid End User Agreement"
},
"AccountAccessForbidden":{
"value":{
"summary":"Couldn't update account balances",
"detail":"Access to account is forbidden. The user might not have the necessary permissions.",
"type":"AccountAccessForbidden",
"status_code":403
},
"summary":"Account Access Forbidden",
"description":"AccountAccessForbidden"
}
}
}
},
"description":"AccountAccessForbidden"
},
"400":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidID":{
"value":{
"summary":"Invalid Account ID",
"detail":"$ACCOUNT_ID is not a valid Account UUID. ",
"status_code":400
},
"summary":"Invalid ID",
"description":"Invalid Account ID"
}
}
}
},
"description":"Invalid Account ID"
},
"500":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"UnknownRequestError":{
"value":{
"summary":"Couldn't update account balances",
"detail":"Request to Institution returned an error",
"type":"UnknownRequestError",
"status_code":500
},
"summary":"Unknown Request Error",
"description":"Couldn't update account balances"
}
}
}
},
"description":"Couldn't update account balances"
},
"409":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"AccountSuspendedError":{
"value":{
"summary":"Account suspended",
"detail":"This account or its requisition was suspended due to numerous errors that occurred while accessing it.",
"status_code":409
},
"summary":"Account suspended error",
"description":"Account or its requisition suspended"
"summary":"Field 'access_scope' may not be an empty list.",
"detail":"Please choose one or several of ['balances', 'details', 'transactions']."
}
],
"status_code":400
},
"summary":"Access scope field errors",
"description":"Errors related to 'access_scope' field."
},
"MaxHistoricalDaysFieldErrors":{
"value":{
"max_historical_days":[
{
"summary":"Incorrect max_historical_days",
"detail":"max_historical_days must be > 0 and <= N26_NTSBDEB1 transaction_total_days (90)"
}
],
"status_code":400
},
"summary":"Max historical days field errors",
"description":"Errors related to 'max_historical_days' field."
},
"AccessValidForDaysFieldErrors":{
"value":{
"access_valid_for_days":[
{
"summary":"Incorrect access_valid_for_days",
"detail":"access_valid_for_days must be > 0 and <= 180"
}
],
"status_code":400
},
"summary":"Access valid for days field errors",
"description":"Errors related to 'access_valid_for_days' field."
},
"AgreementFieldErrors":{
"value":{
"agreement":{
"summary":"Incorrect Institution ID $INSTITUTION_ID",
"detail":"Provided Institution ID: '$INSTITUTION_ID' for requisition does not match EUA institution ID '$EUA_INSTITUTION_ID'. Please provide correct institution ID: '$EUA_INSTITUTION_ID'"
},
"status_code":400
},
"summary":"Agreement field errors",
"description":"Errors related to 'agreement' field."
}
}
}
},
"description":"Errors related to 'agreement' field."
},
"429":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NordigenRateLimitExceeded":{
"value":{
"summary":"Rate limit exceeded",
"detail":"The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds",
"status_code":429
},
"summary":"Nordigen rate limit exceeded",
"description":"Nordigen rate limit exceeded"
}
}
}
},
"description":"Nordigen rate limit exceeded"
},
"402":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"PaymentRequired":{
"value":{
"summary":"Payment Required",
"detail":"Free usage limit exceeded",
"status_code":402
},
"summary":"Payment Required",
"description":"Free usage limit exceeded"
}
}
}
},
"description":"Free usage limit exceeded"
},
"401":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidToken":{
"value":{
"summary":"Invalid token",
"detail":"Token is invalid or expired",
"status_code":401
},
"summary":"Invalid token",
"description":"Token is invalid or expired"
}
}
}
},
"description":"Token is invalid or expired"
},
"403":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"IPAccessDenied":{
"value":{
"summary":"IP address access denied",
"detail":"Your IP $IP_ADDRESS isn't whitelisted to perform this action",
"status_code":403
},
"summary":"IP Access denied",
"description":"IP address not whitelisted"
}
}
}
},
"description":"IP address not whitelisted"
}
}
}
},
"/api/v2/agreements/enduser/{id}/":{
"get":{
"operationId":"retrieve EUA by id",
"description":"Retrieve end user agreement by ID",
"parameters":[
{
"in":"path",
"name":"id",
"schema":{
"type":"string",
"format":"uuid"
},
"description":"A UUID string identifying this end user agreement.",
"required":true
}
],
"tags":[
"agreements"
],
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EndUserAgreement"
}
}
},
"description":"Retrieve end user agreement by ID"
},
"404":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NotFoundError":{
"value":{
"detail":"Not found.",
"summary":"Not found.",
"status_code":404
},
"summary":"Not found error",
"description":"Not found error"
}
}
}
},
"description":"Not found error"
},
"400":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidID":{
"value":{
"summary":"Invalid ID",
"detail":"272785d5-de45-4efb-aa1a-f8157ffa94 is not a valid UUID.",
"status_code":400
},
"summary":"Invalid ID",
"description":"Invalid ID"
}
}
}
},
"description":"Invalid ID"
},
"429":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NordigenRateLimitExceeded":{
"value":{
"summary":"Rate limit exceeded",
"detail":"The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds",
"status_code":429
},
"summary":"Nordigen rate limit exceeded",
"description":"Nordigen rate limit exceeded"
}
}
}
},
"description":"Nordigen rate limit exceeded"
},
"401":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidToken":{
"value":{
"summary":"Invalid token",
"detail":"Token is invalid or expired",
"status_code":401
},
"summary":"Invalid token",
"description":"Token is invalid or expired"
}
}
}
},
"description":"Token is invalid or expired"
},
"403":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"IPAccessDenied":{
"value":{
"summary":"IP address access denied",
"detail":"Your IP $IP_ADDRESS isn't whitelisted to perform this action",
"status_code":403
},
"summary":"IP Access denied",
"description":"IP address not whitelisted"
}
}
}
},
"description":"IP address not whitelisted"
}
}
},
"delete":{
"operationId":"delete EUA by id",
"description":"Delete an end user agreement",
"parameters":[
{
"in":"path",
"name":"id",
"schema":{
"type":"string",
"format":"uuid"
},
"description":"A UUID string identifying this end user agreement.",
"required":true
}
],
"tags":[
"agreements"
],
"responses":{
"400":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"CannotDeleteEUA":{
"value":{
"summary":"Cannot delete End User Agreement",
"detail":"Cannot delete accepted End User Agreement: $EUA_ID. Only non accepted agreements can be deleted",
"status_code":400
},
"summary":"Cannot delete EUA",
"description":"Cannot delete End User Agreement"
},
"InvalidID":{
"value":{
"summary":"Invalid ID",
"detail":"272785d5-de45-4efb-aa1a-f8157ffa94 is not a valid UUID.",
"status_code":400
},
"summary":"Invalid ID",
"description":"Invalid ID"
}
}
}
},
"description":"Invalid ID"
},
"404":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NotFoundError":{
"value":{
"detail":"Not found.",
"summary":"Not found.",
"status_code":404
},
"summary":"Not found error",
"description":"Not found error"
}
}
}
},
"description":"Not found error"
},
"429":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NordigenRateLimitExceeded":{
"value":{
"summary":"Rate limit exceeded",
"detail":"The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds",
"status_code":429
},
"summary":"Nordigen rate limit exceeded",
"description":"Nordigen rate limit exceeded"
}
}
}
},
"description":"Nordigen rate limit exceeded"
},
"401":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidToken":{
"value":{
"summary":"Invalid token",
"detail":"Token is invalid or expired",
"status_code":401
},
"summary":"Invalid token",
"description":"Token is invalid or expired"
}
}
}
},
"description":"Token is invalid or expired"
},
"403":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"IPAccessDenied":{
"value":{
"summary":"IP address access denied",
"detail":"Your IP $IP_ADDRESS isn't whitelisted to perform this action",
"status_code":403
},
"summary":"IP Access denied",
"description":"IP address not whitelisted"
}
}
}
},
"description":"IP address not whitelisted"
}
}
}
},
"/api/v2/agreements/enduser/{id}/accept/":{
"put":{
"operationId":"accept EUA",
"description":"Accept an end-user agreement via the API",
"parameters":[
{
"in":"path",
"name":"id",
"schema":{
"type":"string",
"format":"uuid"
},
"description":"A UUID string identifying this end user agreement.",
"description":"Errors related to 'reference' field."
},
"UserLanguageFieldErrors":{
"value":{
"user_language":{
"summary":"Provided user_language is invalid or not supported",
"detail":"'$LNG_CODE' is an invalid or unsupported language"
},
"status_code":400
},
"summary":"User language field errors",
"description":"Errors related to 'user_language' field."
},
"AgreementFieldErrors":{
"value":{
"agreement":[
{
"summary":"Unknown Institution ID $ASPSP_ID",
"detail":"Get Institution IDs from /institutions/?country={$COUNTRY_CODE}"
},
{
"summary":"Invalid EndUserAgreement ID",
"detail":"$AGREEMENT_ID is not a valid EndUserAgreement UUID. Please specify valid agreement from /api/agreements/enduser/?={$ENDUSER_ID} or create a new one"
}
],
"status_code":400
},
"summary":"Agreement field errors",
"description":"Errors related to 'agreement' field."
},
"RedirectFieldErrors":{
"value":{
"redirect":[
{
"summary":"Redirect URL is required",
"detail":"Where an end user will be redirected after finishing authentication in the Institution"
},
{
"summary":"Invalid redirect URI",
"detail":"Redirect URI must have a valid URI structure"
}
],
"status_code":400
},
"summary":"Redirect field errors",
"description":"Errors related to 'redirect' field."
},
"SSNFieldErrors":{
"value":{
"ssn":{
"summary":"SSN verification not supported",
"detail":"SSN verification not supported for $INSTITUTION_ID"
},
"status_code":400
},
"summary":"SSN field errors",
"description":"Errors related to 'ssn' field."
},
"AccountSelectionFieldErrors":{
"value":{
"account_selection":{
"summary":"Account selection not supported",
"detail":"Account selection not supported for $INSTITUTION_ID"
},
"status_code":400
},
"summary":"Account selection field errors",
"description":"Errors related to 'account_selection' field."
},
"InstitutionFieldErrors":{
"value":{
"institution_id":{
"summary":"Unknown Institution ID $INSTITUTION_ID",
"detail":"Get Institution IDs from /institutions/?country={$COUNTRY_CODE}"
},
"status_code":400
},
"summary":"Institution field errors",
"description":"Errors related to 'institution' field."
},
"UnknownFields":{
"value":{
"summary":"Unknown fields",
"detail":"Unknown fields {${FIELD}} in {${LOCATION}}",
"status_code":400
},
"summary":"Unknown Fields",
"description":"Unknown Fields"
},
"FieldsRequired":{
"value":{
"redirect":[
"This field is required."
],
"institution_id":[
"This field is required."
],
"status_code":400
},
"summary":"Fields required",
"description":"Field is required"
}
}
}
},
"description":"Field is required"
},
"404":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"AgreementNotFoundErrors":{
"value":{
"agreement":{
"summary":"ID $AGREEMENT_ID not found",
"detail":"Please check whether you specified a valid ID"
},
"status_code":404
},
"summary":"Agreement not found errors",
"description":"Errors related to 'agreement' field."
}
}
}
},
"description":"Errors related to 'agreement' field."
},
"429":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NordigenRateLimitExceeded":{
"value":{
"summary":"Rate limit exceeded",
"detail":"The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds",
"status_code":429
},
"summary":"Nordigen rate limit exceeded",
"description":"Nordigen rate limit exceeded"
}
}
}
},
"description":"Nordigen rate limit exceeded"
},
"402":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"PaymentRequired":{
"value":{
"summary":"Payment Required",
"detail":"Free usage limit exceeded",
"status_code":402
},
"summary":"Payment Required",
"description":"Free usage limit exceeded"
}
}
}
},
"description":"Free usage limit exceeded"
},
"401":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidToken":{
"value":{
"summary":"Invalid token",
"detail":"Token is invalid or expired",
"status_code":401
},
"summary":"Invalid token",
"description":"Token is invalid or expired"
}
}
}
},
"description":"Token is invalid or expired"
},
"403":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"IPAccessDenied":{
"value":{
"summary":"IP address access denied",
"detail":"Your IP $IP_ADDRESS isn't whitelisted to perform this action",
"status_code":403
},
"summary":"IP Access denied",
"description":"IP address not whitelisted"
}
}
}
},
"description":"IP address not whitelisted"
}
}
}
},
"/api/v2/requisitions/{id}/":{
"get":{
"operationId":"requisition by id",
"description":"Retrieve a requisition by ID",
"parameters":[
{
"in":"path",
"name":"id",
"schema":{
"type":"string",
"format":"uuid"
},
"description":"A UUID string identifying this requisition.",
"required":true
}
],
"tags":[
"requisitions"
],
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Requisition"
}
}
},
"description":"Get requisition by ID"
},
"404":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NotFoundError":{
"value":{
"detail":"Not found.",
"summary":"Not found.",
"status_code":404
},
"summary":"Not found error",
"description":"Not found error"
}
}
}
},
"description":"Not found error"
},
"400":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidID":{
"value":{
"summary":"Invalid ID",
"detail":"272785d5-de45-4efb-aa1a-f8157ffa94 is not a valid UUID.",
"status_code":400
},
"summary":"Invalid ID",
"description":"Invalid ID"
}
}
}
},
"description":"Invalid ID"
},
"429":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NordigenRateLimitExceeded":{
"value":{
"summary":"Rate limit exceeded",
"detail":"The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds",
"status_code":429
},
"summary":"Nordigen rate limit exceeded",
"description":"Nordigen rate limit exceeded"
}
}
}
},
"description":"Nordigen rate limit exceeded"
},
"401":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidToken":{
"value":{
"summary":"Invalid token",
"detail":"Token is invalid or expired",
"status_code":401
},
"summary":"Invalid token",
"description":"Token is invalid or expired"
}
}
}
},
"description":"Token is invalid or expired"
},
"403":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"IPAccessDenied":{
"value":{
"summary":"IP address access denied",
"detail":"Your IP $IP_ADDRESS isn't whitelisted to perform this action",
"status_code":403
},
"summary":"IP Access denied",
"description":"IP address not whitelisted"
}
}
}
},
"description":"IP address not whitelisted"
}
}
},
"delete":{
"operationId":"delete requisition by id",
"description":"Delete requisition and its end user agreement",
"parameters":[
{
"in":"path",
"name":"id",
"schema":{
"type":"string",
"format":"uuid"
},
"description":"A UUID string identifying this requisition.",
"required":true
}
],
"tags":[
"requisitions"
],
"responses":{
"400":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidID":{
"value":{
"summary":"Invalid ID",
"detail":"272785d5-de45-4efb-aa1a-f8157ffa94 is not a valid UUID.",
"status_code":400
},
"summary":"Invalid ID",
"description":"Invalid ID"
}
}
}
},
"description":"Invalid ID"
},
"404":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NotFoundError":{
"value":{
"detail":"Not found.",
"summary":"Not found.",
"status_code":404
},
"summary":"Not found error",
"description":"Not found error"
}
}
}
},
"description":"Not found error"
},
"429":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"NordigenRateLimitExceeded":{
"value":{
"summary":"Rate limit exceeded",
"detail":"The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds",
"status_code":429
},
"summary":"Nordigen rate limit exceeded",
"description":"Nordigen rate limit exceeded"
}
}
}
},
"description":"Nordigen rate limit exceeded"
},
"401":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"InvalidToken":{
"value":{
"summary":"Invalid token",
"detail":"Token is invalid or expired",
"status_code":401
},
"summary":"Invalid token",
"description":"Token is invalid or expired"
}
}
}
},
"description":"Token is invalid or expired"
},
"403":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorResponse"
},
"examples":{
"IPAccessDenied":{
"value":{
"summary":"IP address access denied",
"detail":"Your IP $IP_ADDRESS isn't whitelisted to perform this action",
"status_code":403
},
"summary":"IP Access denied",
"description":"IP address not whitelisted"
}
}
}
},
"description":"IP address not whitelisted"
}
}
}
},
"/api/v2/token/new/":{
"post":{
"operationId":"Obtain new access/refresh token pair",