Check a purchase code's status

GET

/status

const url = 'https://dev-api.tsp.cl/firma_digital/dev/api/partners/v1/status?p_code=example';
const options = {method: 'GET', headers: {'x-gw': '<x-gw>'}};

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://dev-api.tsp.cl/firma_digital/dev/api/partners/v1/status?p_code=example' \
  --header 'x-gw: <x-gw>'

A simplified status, without exposing internal fields — meant for a partner integrated via the widget to poll how far along a user is, without relying on listening to widget events in real time.

Authorizations

PartnerApiKey

Parameters

Query Parameters

p_code

required

string

Responses

200

application/json

object

success

boolean

data

object

p_code

string

status

In precedence order (the first one that applies wins): CANCELLED (voided, wins even over an already-issued certificate) > EXPIRED (issued but has since expired) > EMITTED (certificate delivered) > LOCKED (blocked before it got issued) > IN_ONBOARDING (midway through the widget flow) > VALIDATED (identity verified, certificate_claim still pending, B2C only) > ACTIVE (exists, nobody has redeemed it) > NOT_FOUND (doesn’t exist). VALIDATED and IN_ONBOARDING aren’t yet part of the purchase_codes.status enum in the unified data model this is migrating toward.

string

Allowed values: NOT_FOUND ACTIVE VALIDATED IN_ONBOARDING EMITTED EXPIRED LOCKED CANCELLED

Example

{
  "success": true,
  "data": {
    "status": "NOT_FOUND"
  }
}

400

Missing p_code parameter.

401

Invalid or missing API Key.