Skip to content

Get candidate


Target audience: Developers

Release version: 3.9.1

Get account candidate


This endpoint returns an account candidate if supplied parameters can be connected to an existing customer in the subscription system.


Environment URI


Identity Scope
No /external/account/r


Name Required Type Description
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]+$/"
zip_code Optional String The zip-code for the customer, will be used together with social_security_number or customer_number to identify customer.
Size range: ..5
Allowed values: "/^[a-zA-Z-_0-9]+$/"

Curl Example

curl --request GET \
  --url \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <token>'


Example response

HTTP 200
    "item": {
        "account_candidate_id": "xxxxxxxxxxx",
        "email": "",
        "first_name": "Ove",
        "last_name": "Ovesson",
        "mobile_phone_number": "0701234567",
        "social_security_number": "620817-9256",
        "customer_number": "xxxx",
        "zip_code": "43921",
        "products": [
                "product_code": "product code",
                "valid_to": "2016-08-02T13:00:00+03:00"


Example error response

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 409 Conflict

Name Type Description
already_exists Object Indicates that a value that must be unique and already exists have been used. IE a duplicate customer_number or social_security_number.

HTTP 500 Internal Server Error

Name Type Description
internal_server_error Object Something unexpected happened server side