- Created by PAYONE Admin on 2019-05-03
Introduction
Checking customer data for any existing adverse criteria.
This request is only available if module “protect” has been ordered.
The customer check is carried out to determine the risk of non-payment of demands against customers. With the help of consumer information (adverse criteria) a score value is determined which you can use to assess the creditworthiness of the customers, get a realistic picture of the risk of non-payment and offer the corresponding types of payment.
For best results please provide “streetname” and “streetnumber” in separate fields. If not possible you can use “street” only.
For “consumerscore” first-/last name is obviously mandatory. Parameter “gender” and “birthday” are mandatory for Boniversum and optional for Arvato but recommended for best results.
Valid combinations (Arvato, Boniversum, SCHUFA) | ||||
---|---|---|---|---|
addresschecktype | consumerscoretype | businessrelation | Remarks | Available countries |
NO, BA, PE | IH, IA, IB, IF | b2c (optional) | Arvato Infoscore Services | DE |
PB | CE | b2c (optional) | Boniversum Services | DE |
BS | SFS | b2c (mandatory) | SCHUFA Services | DE |
BS | SFS, SFM | b2b (mandatory) | SCHUFA Services | DE |
Request "consumerscore" | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Common Parameter | Required | Format | Comment | |||||||||||||||||||||||
+ |
Sub-Account ID, defined by PAYONE Format NUMERIC(5..6)
| |||||||||||||||||||||||||
+ | PAYONE-Services | |||||||||||||||||||||||||
BA | Addresscheck Basic | |||||||||||||||||||||||||
PE | Addresscheck Person | |||||||||||||||||||||||||
NO | Do not carry out address check | |||||||||||||||||||||||||
Boniversum-Services – must be combined with consumerscoretype “CE” | ||||||||||||||||||||||||||
PB | Addresscheck Person | |||||||||||||||||||||||||
SCHUFA-Services – must be combined with consumerscoretype “SFM” / “SFS” | ||||||||||||||||||||||||||
BS | AddressCheck SCHUFA | |||||||||||||||||||||||||
+ |
Specifies type of consumer score to be performed. Format LIST
| |||||||||||||||||||||||||
o |
Value specifies business relation between merchant and customer Format LIST
Request specific:
| |||||||||||||||||||||||||
Request "consumerscore" | ||||||||||||||||||||||||||
Parameter | Required | Format | Comment | |||||||||||||||||||||||
o | First name
First name of customer; optional if company is used, i.e.: you may use
Format CHAR(1..50)
| |||||||||||||||||||||||||
o | Surname
Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50)
| |||||||||||||||||||||||||
o | Company
Company name of customer; The company name is optional if lastname is used, i.e.: you may use
Format CHAR(2..50)
| |||||||||||||||||||||||||
+ | Street number and name (required if "streetname" and "streetnumber" not submitted)
Street number and name (required: at least one character) Format CHAR(1..50)
| |||||||||||||||||||||||||
o | Street name (required if "street" not submitted)
Street name Format CHAR(1..50)
| |||||||||||||||||||||||||
o | Street number (required if "street" not submitted)
Street number Format CHAR(1..50)
| |||||||||||||||||||||||||
+ |
Postcode Format CHAR(2..10) Permitted Symbols
[0-9][A-Z][a-z][
| |||||||||||||||||||||||||
+ |
City of customer Format CHAR(2..50)
| |||||||||||||||||||||||||
+ | ||||||||||||||||||||||||||
o | Mandatory for Boniversum and SCHUFA Services “b2c”
Date of birth of customer Format DATE(8), YYYYMMDD Samples 20190101 19991231
| |||||||||||||||||||||||||
- |
Phone number of customer Format CHAR(1..30)
| |||||||||||||||||||||||||
o | Mandatory for Boniversum
Gender of customer (female / male / diverse* ) Format LIST Permitted values f m d * currently not in use
| |||||||||||||||||||||||||
- |
Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display). If the language is not transferred, the browser language will be used. For a non-supported language English will be used. Format LIST Permitted values ISO 639-1 (Language) 2-letter-codes
|
Response "consumerscore" | ||||||||||||||||||||||||||
Common Parameter | Required | Format | Comment | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | + | Default | VALID / INVALID / ERROR | |||||||||||||||||||||||
Parameter (VALID) - address valid | ||||||||||||||||||||||||||
o |
Response code of address check to return whether address has been corrected Format LIST
| |||||||||||||||||||||||||
+ |
Indication for all consumerscoretypes Format LIST
| |||||||||||||||||||||||||
- |
The scorevalue is a more detailed indication of credit worthiness of customers than the score (traffic light). Please pay attention that the values and the interpretation are provider specific. Format NUMERIC(1..4), values and ranges see table below.
| |||||||||||||||||||||||||
- |
For consumerscoretype: IA, IB, IH, IF; Negative criteria if registered. Format LIST Negative criteria; details see code list: Consumer score Arvato Infoscore - secscore
| |||||||||||||||||||||||||
+ | Default | Person address check result; details see code list: Address check returns (personstatus)
Person address check result; details Format LIST
| ||||||||||||||||||||||||
addressstatus | - | Default | Only available with “CE” and “PB” and only if special address is indicated: Person address check result; details see code list: Consumer score Boniversum VERITA score addressstatus | |||||||||||||||||||||||
provideruserid | - | AN..30 | Only with consumerscoretype: SFS, SFM (b2b/b2c): Internal provider reference | |||||||||||||||||||||||
identityconfirmed | - | Default | Only with consumerscoretype: SFS (b2c)
| |||||||||||||||||||||||
- | Default | Only with consumerscoretype: SFS (b2c): gender of person
| ||||||||||||||||||||||||
legalform | - | AN..100 | Only with consumerscoretype: SFM (b2b): Legal form <code>;<text> e.g. “21;Gesellschaft mit beschränkter Haftung” See list of values: Consumer score SCHUFA legal form | |||||||||||||||||||||||
creditlimitvalue | - | AN..10 | Only with consumerscoretype: SFM (b2b): Creditlimit value | |||||||||||||||||||||||
creditlimitcurrency | - | Default | Only with consumerscoretype: SFM (b2b): Creditlimit currency (ISO-code) | |||||||||||||||||||||||
foundingdate | - | AN..10 | Only with consumerscoretype: SFM (b2b): Founding date in format yyyy-mm-dd | |||||||||||||||||||||||
taxid | - | AN..20 | Only with consumerscoretype: SFM (b2b): Tax id of company | |||||||||||||||||||||||
- | For consumerscoretype: SFM (b2b), Return of company (corrected if applicable)
Company name of customer; The company name is optional if lastname is used, i.e.: you may use
Format CHAR(2..50)
| |||||||||||||||||||||||||
+ | Return of first name (corrected if applicable)
First name of customer; optional if company is used, i.e.: you may use
Format CHAR(1..50)
| |||||||||||||||||||||||||
+ | Return of surname (corrected if applicable)
Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50)
| |||||||||||||||||||||||||
+ | Return of street + street no. (corrected if applicable)
Street number and name (required: at least one character) Format CHAR(1..50)
| |||||||||||||||||||||||||
- | Return of street name (corrected if applicable)
Street name Format CHAR(1..50)
| |||||||||||||||||||||||||
- | Return of street number (corrected if applicable)
Street number Format CHAR(1..50)
| |||||||||||||||||||||||||
+ | Return of postal code (corrected if applicable)
Postcode Format CHAR(2..10) Permitted Symbols
[0-9][A-Z][a-z][
| |||||||||||||||||||||||||
+ | Return of city (corrected if applicable)
City of customer Format CHAR(2..50)
| |||||||||||||||||||||||||
Parameter (INVALID) - address invalid | ||||||||||||||||||||||||||
+ | 30 address could not be corrected | |||||||||||||||||||||||||
+ |
In case of error the PAYONE Platform returns an error code for your internal usage. Format NUMERIC(1..6)
| |||||||||||||||||||||||||
+ |
In case of error the PAYONE Platform returns an error message for your internal usage. Format CHAR(1..1024)
| |||||||||||||||||||||||||
- |
The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format CHAR(1..1024)
| |||||||||||||||||||||||||
Parameter (ERROR) - error | ||||||||||||||||||||||||||
+ |
In case of error the PAYONE Platform returns an error code for your internal usage. Format NUMERIC(1..6)
| |||||||||||||||||||||||||
+ |
In case of error the PAYONE Platform returns an error message for your internal usage. Format CHAR(1..1024)
| |||||||||||||||||||||||||
- |
The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format CHAR(1..1024)
|
- No labels