Get an issuer onboarding
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.flashpi.com.ec/v1/issuer-onboardings/example"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://api.flashpi.com.ec/v1/issuer-onboardings/example"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.flashpi.com.ec/v1/issuer-onboardings/example")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build();HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());System.out.println(response.body());const url = 'https://api.flashpi.com.ec/v1/issuer-onboardings/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.flashpi.com.ec/v1/issuer-onboardings/example \ --header 'Authorization: Bearer <token>'Poll it while verifying (every few seconds; verification usually takes under a minute). An onboarding is deleted 30 days after it is completed, expires or is rejected, and then answers 404 not_found. Requires an account-scoped (global) API key with read_write access, of either mode: the certificate serves test and live documents.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Header Parameters
Section titled “Header Parameters”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.
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
Section titled “Responses”An issuer onboarding from a .p12: Flashpi verifies the certificate (verifying), then it is ready with the certificate’s facts, the RUC and, when the registry lookup is on, the SRI’s profile, or rejected. Completing it creates the issuer (or renews an existing one) with the certificate, which serves test and live. It expired if not completed within 6 days, and it is deleted 30 days after it ends.
object
When it expires unless completed.
Public facts of the verified certificate (no key material).
object
The certificate holder’s names.
object
Common name (CN): the holder’s name.
Organization (O): usually the company of a legal representative.
The identification the certificate carries: its RUC (rucSource certificate), or the holder’s cédula, from which Flashpi proposes the RUC cédula + 001 (rucSource cedula).
object
The RUC to complete with: the certificate’s, or the holder’s cédula followed by 001.
Whether the customer must confirm (or type) the RUC: it did not come from the certificate itself. Then complete must send ruc.
What the SRI’s public RUC registry said about the RUC (best effort). unavailable: it did not answer. disabled: Flashpi did not ask it (the lookup is off). In both cases profile is null and the customer fills in the tax profile. Warnings never block.
object
The taxpayer’s profile in the SRI’s public RUC registry, normalized. The registry gives flags only for special taxpayer and withholding agent: the resolution numbers are the customer’s to type.
object
Razón social.
Nombre comercial.
The RUC status as the SRI writes it.
general: not in RIMPE. unknown: the SRI answer could not be mapped; the customer chooses.
The head office address.
inactive: the RUC is not ACTIVO; ghost and nonexistent_transactions: the SRI flags the taxpayer; head_office_closed: its head office establishment is closed.
Values for the issuer’s tax profile: the SRI’s legal name first, else the certificate’s organization (companies) or common name (persons); the trade name, the head office address and the tax profile from the SRI when it answered (sri.status found), otherwise null. They are the customer’s to check and edit.
object
The tax profile to start from; null where nothing is known.
object
general means not in RIMPE (complete with rimpeRegime: null); null means unknown.
The SRI says special taxpayer: ask for the resolution number.
The SRI says withholding agent: ask for the resolution number.
Example
{ "status": "verifying", "rejection": { "code": "invalid_password", "message": "The password does not open the .p12 file." }, "certificate": { "serialNumber": "4f2a9c01", "issuingCa": { "code": "SECURITY_DATA", "displayName": "Security Data" }, "holder": { "commonName": "JUAN CARLOS PEREZ LOPEZ", "organization": "SUPERMERCADOS LA PRADERA S.A." }, "identification": { "ruc": "1790012345001", "rucSource": "certificate", "cedula": "1712345678" } }, "proposedRuc": "1790012345001", "existingIssuer": { "legalName": "Supermercados La Pradera S.A." }, "sri": { "status": "found", "profile": { "taxpayerStatus": "ACTIVO", "rimpeRegime": "entrepreneur" }, "warnings": [ "inactive" ] }, "prefill": { "ruc": "1790012345001", "taxProfile": { "rimpeRegime": "entrepreneur" } }}Headers
Section titled “Headers”Flashpi’s ID of the request, a UUIDv7 (also requestId in errors). Include it when you contact support.
authentication_required: no Authorization: Bearer header. invalid_api_key: the key is malformed, unknown or revoked.
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
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.
Localized summary of the type.
HTTP status code.
Localized explanation of this occurrence.
Path of the request.
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.
Field-level errors (may be empty).
object
Path of the invalid field.
Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.
Localized message.
Request ID (UUIDv7); include it when contacting support.
idempotency_key_reused: the document the Idempotency-Key already created.
The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).
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.
ride_not_available: the status of the RIDE.
document_not_authorized: the status of the document.
email_sending_paused: the mode whose email sending is paused.
total_mismatch: the expectedTotal you sent.
total_mismatch: the total Flashpi computed.
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
Section titled “Headers”RFC 6750 challenge: Bearer realm="flashpi", plus error="invalid_token" with invalid_api_key.
The API key cannot perform this operation: key_scope_mismatch, key_read_only or ip_not_allowed; or its account is suspended (account_suspended).
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
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.
Localized summary of the type.
HTTP status code.
Localized explanation of this occurrence.
Path of the request.
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.
Field-level errors (may be empty).
object
Path of the invalid field.
Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.
Localized message.
Request ID (UUIDv7); include it when contacting support.
idempotency_key_reused: the document the Idempotency-Key already created.
The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).
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.
ride_not_available: the status of the RIDE.
document_not_authorized: the status of the document.
email_sending_paused: the mode whose email sending is paused.
total_mismatch: the expectedTotal you sent.
total_mismatch: the total Flashpi computed.
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"}Not_found
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
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.
Localized summary of the type.
HTTP status code.
Localized explanation of this occurrence.
Path of the request.
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.
Field-level errors (may be empty).
object
Path of the invalid field.
Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.
Localized message.
Request ID (UUIDv7); include it when contacting support.
idempotency_key_reused: the document the Idempotency-Key already created.
The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).
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.
ride_not_available: the status of the RIDE.
document_not_authorized: the status of the document.
email_sending_paused: the mode whose email sending is paused.
total_mismatch: the expectedTotal you sent.
total_mismatch: the total Flashpi computed.
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"}