Lookup address
/v2/accounts/lookup_address
Target audience: Developers
Release version: 4.7.5
Lookup address¶
Introduction¶
This endpoint returns the address information connected to a ssn, taking leverage of the national registry. Please contact support if you have any questions about this.
URI¶
| Environment | URI |
|---|---|
| Stage | https://payway-api.stage.adeprimo.se/external/api/v2/accounts/lookup_address |
| Production | https://backend.worldoftulo.com/external/api/v2/accounts/lookup_address |
Requirements¶
| Identity | Scope |
|---|---|
| No | /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¶
curl --request GET \
--url https://payway-api.stage.adeprimo.se/external/api/v2/accounts/lookup_address?social_security_number=dddddddddddd \
--header 'accept: application/json' \
--header 'authorization: Bearer <token>'
Example Response¶
"item": {
// Payway Address. See Entities/Payway Address //
}
A successful response item will contain a Payway Address.
Errors¶
This API uses the common error conventions of the Payway API