Home > API > Customer Account > Lookup account by SSN

Lookup account by SSN

Find customer account by SSN (social security number)

PATH:

/api/v3/customer-account/{ssn}

PATH PARAMETERS:

ssn
required

string

RESPONSES:

200 OK

RESPONSE SCHEMA:

account

account object

undefined

accountLimit

number

Amount of granted account limit if account has limit assigned to it

accountNumber

string

Customeraccounts identifier

accountProfile

string

Identifier of a specific accountProfile

accountStatus

string

Enum: Ok FirstReminder SecondReminder UnderCancelation SentToDebtCollection ClosedFromDebtCollection

Account status

balance

number

Current ledger balance

bankAccount

string

Bank account, which is linked to this account

customerId

string

Customer ID, which is linked to this account

createdAt

string

Date and time when account was created

isStopped

boolean

Indicates whether account is stopped or not

ocr

string

OCR (Optical Character Recognition) number bound to this account

lastNoticeDate

string

Date of last notice

nextNoticeDate

string

Date of next notice

customer

customer object

Customer details

customerNumber

string <= 100 characters

Customer number

customerAccountId

string <= 50 characters

Customer account id

firstName

string <= 50 characters

First name

lastName

string <= 50 characters

Last name

addressList

array of addressList

Address list

Array () [
street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.


]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

get

/api/v3/customer-account/{ssn}

Response samples

200400
  • {
    • "account": { ...
      • "accountLimit": 1.00,
      • "accountNumber": "string",
      • "accountProfile": "string",
      • "accountStatus": "string",
      • "balance": 1.00,
      • "bankAccount": "string",
      • "customerId": "string",
      • "createdAt": "string",
      • "isStopped": true,
      • "ocr": "string",
      • "lastNoticeDate": "string",
      • "nextNoticeDate": "string"
      },
    • "customer": { ...
      • "customerNumber": "string",
      • "customerAccountId": "string",
      • "firstName": "string",
      • "lastName": "string",
      • "addressList": [ ...
        • {
          • "street": "string",
          • "streetNumber": "string",
          • "streetNumberAdditional": "string",
          • "postalCode": "string",
          • "postalPlace": "string",
          • "countryCode": "string",
          • "careOf": "string"
          }
        ]
      }
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]