Cerrtify
Person Data

Search by name/address (raw SPAR XML)

Searches SPAR by any combination of name and address fields. Returns raw SPAR SOAP XML. > **Production uses your own SPAR agreement.** Upload the certificate and > Skatteverket's customer numbers in the Cerrtify dashboard; until then > production returns `403 spar_not_configured`. Sandbox uses the > platform's test certificate against Skatteverket's SPAR test > environment; you need none of your own.

POST
/service/persondata/search/name-address

Authorization

ApiKeyAuth
X-API-Key<token>

API key in the form cert_<prefix>_<secret>.

In: header

Query Parameters

async?boolean

Run the call as a background job and return 202 Accepted with a job_id.

priority?string

Queue priority for async jobs.

Value in

  • "low"
  • "default"
  • "high"

Header Parameters

Idempotency-Key?string

Dedupe key so a retried async enqueue does not create a duplicate job.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

At least one field must be set; empty fields are omitted from the SPAR query. SPAR's own limits apply and are checked before the call (400 invalid_request): names take letters, digits, spaces and * - ' (fornamn max 80, mellanEfternamn max 60 characters); utdelningsadress also / . , : (max 100); postort letters, digits, spaces, * and - (max 27); postnr five digits.

Response Body

application/xml

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/service/persondata/search/name-address" \  -H "Content-Type: application/json" \  -d '{}'
"string"
{  "job_id": "string",  "status": "queued",  "poll": "/service/jobs/<id>"}
{  "error": "string",  "detail": "string"}
{  "error": "string",  "detail": "string"}
{  "error": "insufficient_credits",  "message": "Organisationen har slut på krediter. Fyll på för att fortsätta."}
{  "error": "string",  "detail": "string"}
{  "error": "string",  "detail": "string"}
{  "error": "upstream_unavailable",  "service": "bankid",  "message": "There is currently a problem with BankID. Please try again shortly."}
{  "error": "string",  "detail": "string"}

Look up a person by Swedish ID number (parsed JSON) POST

As `/search/id`, but the SPAR response is parsed into JSON. Always synchronous (`?async` is ignored). > **Production uses your own SPAR agreement.** Upload the certificate and > Skatteverket's customer numbers in the Cerrtify dashboard; until then > production returns `403 spar_not_configured`. Sandbox uses the > platform's test certificate against Skatteverket's SPAR test > environment; you need none of your own.

Search by name/address (parsed JSON) POST

As `/search/name-address`, but parsed into JSON. Always synchronous. > **Production uses your own SPAR agreement.** Upload the certificate and > Skatteverket's customer numbers in the Cerrtify dashboard; until then > production returns `403 spar_not_configured`. Sandbox uses the > platform's test certificate against Skatteverket's SPAR test > environment; you need none of your own.