Skip to content

Get

/accounts

Target audience: Developers 

1
Release version: 3.9.1

Introduction

This endpoint returns an account.

URI

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

Required scope

1
/external/account/w

Parameters

Name Required Type Description
id Optional String The id of the account to get information about.
Size range: ..24
Allowed values: "/^[a-f\d]{24}$/i"
email Optional String The email of the account to get information about.
Size range: ..1024
Allowed values:
"/\A[\w+-.]+@[a-z\d-]+(.[a-z]+)*.[a-z]+\z/i"
social_security_number Optional String The account's social security number. If this parameter is used it's value must be unique, must be supplied unless customer_number is provided.
Allowed values: "dddddd-dddd"
customer_number Optional String The customer number for the account candidate. If this parameter is used it's value must be unique, must be supplied unless social_security_number is provided.
Size range: ..10
Allowed values: "/^[a-zA-Z-_0-9]+$/"

Curl Example

Email

1
2
3
4
curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/accounts?email=test@example.com \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token_with_identity>'

Customer number

1
2
3
4
curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/accounts?customer_number=0701234567 \
  --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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
HTTP 200
{
    "id": "585a4768edce2c5e6f000001",
    "email": "user@email.com",
    "status": "created",
    "verified": false,
    "customer_number": "12345",
    "first_name": "Kalle",
    "last_name": "Anka",
    "mobile_phone_number": "50460531",
    "social_security_number": "800610-8230",
    "company_registration_number": null,
    "alias": "Kalle123",
    "address": {
        "first_name": "Kalle",
        "last_name": "Anka",
        "street": "The Streets",
        "street_number": "12",
        "staircase": "A",
        "floor": "3",
        "apartment_number": "13",
        "zip_code": "83242",
        "city": "Stockholm",
        "drop_box": null,
        "country_code": "SE"
    },
    "user_products": [
        {
            "id": "585a4768edce2c5e6f000003",
            "created": "2016-12-21T10:12:08+01:00",
            "updated": "2016-12-21T10:12:08+01:00",
            "product_code": "package_code",
            "title_code": "TITLE_CODE",
            "valid_from": "2016-12-20T10:12:08+01:00",
            "valid_to": "2016-12-22T10:12:08+01:00",
            "provision_service": "tulo",
            "subscription_type": "recurring",
            "subscription_number": "12345",
            "state": "activated"
        }
    ],
    "accepted_marketing_permissions": [
        {
            "id": "5ba4a64509c04c5ab4000001",
            "type": "sms"
        }
    ]
}

Errors

Example error response

1
2
3
4
5
6
HTTP 400 Bad Request
{
  "code": "invalid_parameter",
  "field": "social_security_number",
  "message": "Parameter must match format (/^[0-9]{6}-[0-9]{4}$/)"
}

HTTP 400 Bad Request

Name Type Description
unknown_parameter Object One or more of the fields in the posted json was not recognized

HTTP 404 Not Found

Name Type Description
not_found Object The account could not be found

HTTP 500 Internal Server Error

Name Type Description
internal_server_error Object Something unexpected happened server side