Get the XML of a document

GET

/v1/documents/{documentId}/xml

curl --request GET \
  --url https://api.flashpi.com.ec/v1/documents/example/xml \
  --header 'Authorization: Bearer <token>'

• Production (test and live keys)

The most advanced XML available: the authorized XML once the SRI authorized the document, else the signed XML, else the unsigned XML Flashpi built. The Flashpi-Xml-Kind header says which one (authorized, signed or unsigned). Any API key can read (read_only included); an issuer-scoped key only sees its issuer. Test keys see test documents and live keys live documents.

Authorizations

• apiKey

Parameters

Path Parameters

documentId

required

string

Header Parameters

Accept-Language

string

Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is es or es- plus a region (es-EC, es-419), English otherwise. Errors state it in Content-Language.

X-Correlation-Id

string

>= 1 characters <= 128 characters /^[A-Za-z0-9._:/+=-]{1,128}$/

Your own ID for the request (letters, digits and -_.:/+=), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.

Responses

200

The XML document.

Media typeapplication/xml

string

Headers

Flashpi-Xml-Kind

string

Allowed values: authorized signed unsigned

authorized, signed or unsigned.

X-Request-Id

string format: uuid

Flashpi’s ID of the request, a UUIDv7 (also requestId in errors). Include it when you contact support.

401

authentication_required: no Authorization: Bearer header. invalid_api_key: the key is malformed, unknown or revoked.

Media typeapplication/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

Headers

WWW-Authenticate

string

RFC 6750 challenge: Bearer realm="flashpi", plus error="invalid_token" with invalid_api_key.

403

The API key cannot perform this operation: key_scope_mismatch, key_read_only or ip_not_allowed; or its account is suspended (account_suspended).

Media typeapplication/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

404

Not_found: no such document, or a test document whose files were deleted (the files of test documents are kept 90 days after they are stored; the detail says so).

Media typeapplication/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}