Skip to content

/lookup_address

/accounts/lookup_address

Target audience: Developers

1
Release version: 3.9.1

Introduction

This endpoint returns the address information connected to a ssn, taking leverage of the national registry. Please contact Sanjin Coralic if you have any questions about this.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/accounts/lookup_address
Production https://backend.worldoftulo.com/external/api/v1/accounts/lookup_address

Required scope

1
/external/account/r

Parameters

Name Required Type Description
social_security_number Required String The social security number to look up.
Size range: 10..12
Allowed values: "dddddd-dddd or "dddddddddd""

Curl Example

1
2
3
4
curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/lookup_address?social_security_number=dddddddddddd \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token_with_identity>'

Response

Example response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
HTTP 200
{
    "item": {
        "first_name": "Anders",
        "last_name": "Andersson",
        "street": "Anders gata",
        "street_number": "12",
        "staircase": "A",
        "floor": "3",
        "apartment_number": "13",
        "zip_code": "83242",
        "city": "Stockholm",
        "drop_box": null
    }
}

Errors

Example error response

1
2
3
4
5
HTTP 400 Bad Request
{
    "code": "invalid_parameter",
    "message": "expecting something like 620817-9256 or 196208179256"
}

HTTP 400 Bad Request

Name Type Description
invalid_parameter Object One or more of the parameters was not recognized

HTTP 403 Forbidden

Name Type Description
forbidden Object Customer lookup service is not registered on your account.

HTTP 404 Not Found

Name Type Description
not_found Object The social_security_number could not be found

HTTP 500 Internal Server Error

Name Type Description
internal_server_error Object Something unexpected happened server side