Onboard a new customer
POST/wallet-setup/customer-persons
Onboard a new customer by providing their details and credentials. This information is used to verify and set up the customer's wallet, ensuring they meet all necessary requirements.
Only users who are not identified as Politically Exposed Persons (PEPs) or sanctioned individuals will have a wallet created. The onboarding process is controlled to ensure that only eligible customers proceed, in accordance with our agreement with partners for compliance and security.
Once successfully onboarded, the customer can be authenticated through their provided contact methods (e.g., email or SMS).
Request
- application/json
Body
- ARCHITECTURE_CARTOGRAPHY_SURVEYOR - "Architecture, Cartography, Surveyor"
- LIFE_PHYSICAL_AND_SOCIAL_SCIENCES - "Life, Physical, and Social Sciences"
- COMMUNITY_AND_SOCIAL_SERVICES - "Community and Social Services"
- NEWS_AND_REPORTING_SERVICES - "News and Reporting Services"
- HEALTHCARE_SERVICES - "Healthcare Services"
- LAW_ENFORCEMENT_AND_PUBLIC_SAFETY - "Law Enforcement and Public Safety"
- FOOD_AND_BEVERAGE_INDUSTRY - "Food and Beverage Industry"
- DOMESTIC_SERVICES - "Domestic Services"
- PERSONAL_CARE_PROFESSIONAL_SERVICES - "Personal Care Professional Services"
- SALES_AND_RELATED_OCCUPATIONS - "Sales and Related Occupations"
- OFFICE_ADMINISTRATION_AND_SUPPORT - "Office Administration and Support"
- FARMING_FISHING_AND_FORESTRY_SERVICES - "Farming, Fishing and Forestry Services"
- CONSTRUCTION_AND_RELATED_SERVICES - "Construction and Related Services"
- MANUFACTURING_SERVICES - "Manufacturing Services"
- TRANSPORTATION_SERVICES - "Transportation Services"
- ENTERTAINMENT_MEDIA - "Entertainment and Media"
- UNEMPLOYED - "Unemployed"
- STUDENT - "Student"
- PENSIONER - "Pensioner"
- SPORTS_INDUSTRY - "Sports Industry"
- BETTING_INDUSTRY - "Betting Industry"
- ART_AND_DESIGN - "Art and Design"
- EDUCATION_AND_EDUCATIONAL_SURVICES - "Education and Educational Support Services"
- ENGINEERING - "Engineering"
- FINANCIAL_AND_INSURANCE_SERVICES - "Financial and Insurance Services"
- IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT - "IT Software, Hardware and Website Development"
- LEGAL_AND_COMPLIANCE_SERVICES - "Legal and Compliance Services"
- MANAGEMENT_CONSULTING - "Management Consulting"
- WEAPON_INDUSTRY - "Weapon Industry"
- CHARITY_AND_NON_PROFIT_SERVICES - "Charity, Non-Profit Services"
- FREELANCER_SELF_EMPLOYED - "Freelancer, Self-employed"
- PUBLIC_SECTOR - "Public Sector"
Possible values: <= 15 characters
Personal title, Mr., Dr., etc.
Possible values: <= 50 characters
First name.
Possible values: <= 50 characters
Last name.
Birth date in YYYY-MM-DD format.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: [ARCHITECTURE_CARTOGRAPHY_SURVEYOR
, LIFE_PHYSICAL_AND_SOCIAL_SCIENCES
, COMMUNITY_AND_SOCIAL_SERVICES
, NEWS_AND_REPORTING_SERVICES
, HEALTHCARE_SERVICES
, LAW_ENFORCEMENT_AND_PUBLIC_SAFETY
, FOOD_AND_BEVERAGE_INDUSTRY
, DOMESTIC_SERVICES
, PERSONAL_CARE_PROFESSIONAL_SERVICES
, SALES_AND_RELATED_OCCUPATIONS
, OFFICE_ADMINISTRATION_AND_SUPPORT
, FARMING_FISHING_AND_FORESTRY_SERVICES
, CONSTRUCTION_AND_RELATED_SERVICES
, MANUFACTURING_SERVICES
, TRANSPORTATION_SERVICES
, ENTERTAINMENT_MEDIA
, UNEMPLOYED
, STUDENT
, PENSIONER
, SPORTS_INDUSTRY
, BETTING_INDUSTRY
, ART_AND_DESIGN
, EDUCATION_AND_EDUCATIONAL_SURVICES
, ENGINEERING
, FINANCIAL_AND_INSURANCE_SERVICES
, IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT
, LEGAL_AND_COMPLIANCE_SERVICES
, MANAGEMENT_CONSULTING
, WEAPON_INDUSTRY
, CHARITY_AND_NON_PROFIT_SERVICES
, FREELANCER_SELF_EMPLOYED
, PUBLIC_SECTOR
]
Valid occupation:
Possible values: [PHYSICAL_DISABILITY
, LOW_MENTAL_CAPACITY
, GAMBLING_ADDICTION
, FINANCE_MISMANAGEMENT
, POOR_LITERACY
, POOR_LANGUAGE_SKILLS
, POOR_DIGITAL_SKILLS
, CARING_RESPONSIBILITIES
, FRAUDULENT_LOCATION
]
customerIdentifiers
object
required
Customer identifiers used in processes where verified identifier is required. Based on brand configurations, at least one identifier must be provided in the request.
Email example:
value
- john.doe@paysafe.com
verificationId
- 06bdcd2c-0cce-4b36-97ec-281c8f5d743c
Mobile example:
value
- +359897765463
verificationId
- 06bdcd2c-0cce-4b36-97ec-281c8f5d743c
email
object
Unique customer identifier used for processes requiring verified identifier, such as email, mobile number, etc.
Identifier's value, such as email, mobile number etc.
A unique identifier for the verification process associated with the customer attribute.
mobile
object
Unique customer identifier used for processes requiring verified identifier, such as email, mobile number, etc.
Identifier's value, such as email, mobile number etc.
A unique identifier for the verification process associated with the customer attribute.
customerCredentials
object
required
Credentials used for recovery or customer onboarding.
The customer's password.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
address
object
required
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: <= 2 characters
US state postal abbreviation. Not used for non US territories.
Possible values: <= 50 characters
Possible values: non-empty
and <= 50 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Terms and conditions.
deviceInfo
object
required
Provides information about the device that the end-customer uses to access the service.
Possible values: [WEB_APP
, MOBILE_APP
, API
]
The type of application used by the end-customer to access the service.
Possible values: <= 100 characters
ThreatMetrics session identifier.
Identifies wether an individual is a Politically Exposed Person (PEP)
Responses
- 201
- 400
- 401
- 409
- 500
- 503
Created
- application/json
- Schema
- Example (from schema)
- CUSTOMER_ONBORADING_RESPONSE
Schema
- ARCHITECTURE_CARTOGRAPHY_SURVEYOR - "Architecture, Cartography, Surveyor"
- LIFE_PHYSICAL_AND_SOCIAL_SCIENCES - "Life, Physical, and Social Sciences"
- COMMUNITY_AND_SOCIAL_SERVICES - "Community and Social Services"
- NEWS_AND_REPORTING_SERVICES - "News and Reporting Services"
- HEALTHCARE_SERVICES - "Healthcare Services"
- LAW_ENFORCEMENT_AND_PUBLIC_SAFETY - "Law Enforcement and Public Safety"
- FOOD_AND_BEVERAGE_INDUSTRY - "Food and Beverage Industry"
- DOMESTIC_SERVICES - "Domestic Services"
- PERSONAL_CARE_PROFESSIONAL_SERVICES - "Personal Care Professional Services"
- SALES_AND_RELATED_OCCUPATIONS - "Sales and Related Occupations"
- OFFICE_ADMINISTRATION_AND_SUPPORT - "Office Administration and Support"
- FARMING_FISHING_AND_FORESTRY_SERVICES - "Farming, Fishing and Forestry Services"
- CONSTRUCTION_AND_RELATED_SERVICES - "Construction and Related Services"
- MANUFACTURING_SERVICES - "Manufacturing Services"
- TRANSPORTATION_SERVICES - "Transportation Services"
- ENTERTAINMENT_MEDIA - "Entertainment and Media"
- UNEMPLOYED - "Unemployed"
- STUDENT - "Student"
- PENSIONER - "Pensioner"
- SPORTS_INDUSTRY - "Sports Industry"
- BETTING_INDUSTRY - "Betting Industry"
- ART_AND_DESIGN - "Art and Design"
- EDUCATION_AND_EDUCATIONAL_SURVICES - "Education and Educational Support Services"
- ENGINEERING - "Engineering"
- FINANCIAL_AND_INSURANCE_SERVICES - "Financial and Insurance Services"
- IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT - "IT Software, Hardware and Website Development"
- LEGAL_AND_COMPLIANCE_SERVICES - "Legal and Compliance Services"
- MANAGEMENT_CONSULTING - "Management Consulting"
- WEAPON_INDUSTRY - "Weapon Industry"
- CHARITY_AND_NON_PROFIT_SERVICES - "Charity, Non-Profit Services"
- FREELANCER_SELF_EMPLOYED - "Freelancer, Self-employed"
- PUBLIC_SECTOR - "Public Sector"
Array [
- ALL_TRANSACTIONS - Block all types of transactions.
- OUTGOING_TRANSACTIONS - Block withdrawals and send money transactions.
- INCOMING_TRANSACTIONS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks.
- SEND_MONEY - Block all send money transactions to other customers and merchants.
- INCOMING_TRANSACTIONS_AND_SEND_MONEY - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks. Block all send money transactions to other customers and merchants.
- CARD_DEPOSITS - Block all deposit made by card.
- CARD_AND_ACH_DEPOSITS - Block all deposit made by card and ACH bank deposits.
- DEPOSITS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits.
- OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS - Block withdrawals and send money transactions and all card deposits.
- OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS - Block all types of withdrawals (including ATM and POS trn with prepaid card) and ACH deposits.
- DEPOSITS_AND_WITHDRAWALS - Bocks all withdrawals and deposits.
- CRYPTO_TRANSACTIONS - Block all crypto trn including buy and sell, received and send crypto.
- OTHER - Other restrictions.
]
Array [
Array [
- CARD
- SEPA_BANK_ACCOUNT
- UK_BANK_ACCOUNT
- US_BANK_ACCOUNT
- CCI_BANK_ACCOUNT
- VISA - VISA
- MC - Mastercard The scheme is derived from the card PAN.
]
]
Possible values: <= 20 characters
Paysafe embedded wallet internal identifier.
Possible values: <= 15 characters
Personal title, Mr., Dr., etc.
Possible values: <= 50 characters
First name.
Possible values: <= 50 characters
Last name.
Birth date in YYYY-MM-DD format.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: [ARCHITECTURE_CARTOGRAPHY_SURVEYOR
, LIFE_PHYSICAL_AND_SOCIAL_SCIENCES
, COMMUNITY_AND_SOCIAL_SERVICES
, NEWS_AND_REPORTING_SERVICES
, HEALTHCARE_SERVICES
, LAW_ENFORCEMENT_AND_PUBLIC_SAFETY
, FOOD_AND_BEVERAGE_INDUSTRY
, DOMESTIC_SERVICES
, PERSONAL_CARE_PROFESSIONAL_SERVICES
, SALES_AND_RELATED_OCCUPATIONS
, OFFICE_ADMINISTRATION_AND_SUPPORT
, FARMING_FISHING_AND_FORESTRY_SERVICES
, CONSTRUCTION_AND_RELATED_SERVICES
, MANUFACTURING_SERVICES
, TRANSPORTATION_SERVICES
, ENTERTAINMENT_MEDIA
, UNEMPLOYED
, STUDENT
, PENSIONER
, SPORTS_INDUSTRY
, BETTING_INDUSTRY
, ART_AND_DESIGN
, EDUCATION_AND_EDUCATIONAL_SURVICES
, ENGINEERING
, FINANCIAL_AND_INSURANCE_SERVICES
, IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT
, LEGAL_AND_COMPLIANCE_SERVICES
, MANAGEMENT_CONSULTING
, WEAPON_INDUSTRY
, CHARITY_AND_NON_PROFIT_SERVICES
, FREELANCER_SELF_EMPLOYED
, PUBLIC_SECTOR
]
Valid occupation:
Possible values: [PHYSICAL_DISABILITY
, LOW_MENTAL_CAPACITY
, GAMBLING_ADDICTION
, FINANCE_MISMANAGEMENT
, POOR_LITERACY
, POOR_LANGUAGE_SKILLS
, POOR_DIGITAL_SKILLS
, CARING_RESPONSIBILITIES
, FRAUDULENT_LOCATION
]
List of vulnerabilities.
Possible values: non-empty
and <= 40 characters
External identifier in merchant system. Must be passed during onboarding.
address
object
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: <= 2 characters
US state postal abbreviation. Not used for non US territories.
Possible values: <= 50 characters
Possible values: non-empty
and <= 50 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
contactInfo
object
Contact information
Mobile number
Type of Customer
restrictions
object[]
Restrictions placed on the customer.
Possible values: [ALL_TRANSACTIONS
, OUTGOING_TRANSACTIONS
, INCOMING_TRANSACTIONS
, SEND_MONEY
, INCOMING_TRANSACTIONS_AND_SEND_MONEY
, CARD_DEPOSITS
, CARD_AND_ACH_DEPOSITS
, DEPOSITS
, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS
, OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS
, DEPOSITS_AND_WITHDRAWALS
, CRYPTO_TRANSACTIONS
, OTHER
]
Restrictions applied to customer wallet.
Possible values: [CONTACT_CUSTOMER_SERVICE
, KYC_VERIFICATION
, BANK_ACCOUNT_VERIFICATION
, PEP_DECLARATION
, WAIT
, OTHER
, MANUAL_REVIEW
, COMPLETE_ONBOARDING
]
Actions to be completed in order to resolve
Represents RFC 3339, section 5.6 date-time.
Restriction id
Represents RFC 3339, section 5.6 date-time.
Represents RFC 3339, section 5.6 date-time.
accounts
object[]
Accounts associated with this customer.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
Possible values: <= 20 characters
Account id.
Possible values: <= 20 characters
Paysafe embedded wallet internal customer identifier.
Possible values: non-empty
and <= 40 characters
External identifier in merchant system. Must be passed during onboarding.
Amount in minor units
Amount in minor units
instruments
object[]
List of payment instruments associated with this account, provided by Paysafe. This list might include virtual bank accounts or pre-paid cards funded by the account.
The instrument id
Customer to which this instrument belongs.
instrumentType
string
required
Possible values: [CARD
, SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
, CCI_BANK_ACCOUNT
]
Instrument type.
Value | Description |
---|---|
SEPA_BANK_ACCOUNT | SEPA Bank account |
UK_BANK_ACCOUNT | UK Bank account |
US_BANK_ACCOUNT | US Bank account |
CCI_BANK_ACCOUNT | CCI Bank account |
CARD | Card |
Card Number
Possible values: <= 160 characters
Card holder name.
Bank name.
expiryDate
object
required
Card expiry date.
Possible values: [VISA
, MC
]
Card scheme information.
Possible values: <= 20 characters
Name to be associated with the card.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
The International Bank Account Number (IBAN) of the account.
The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.
Bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
A bank account number.
Use our sort code checker to easily find and check UK sort codes.
Bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account. As per regulations the Wallet holder and bank account holder must be the same.
Possible values: >= 4 characters
and <= 17 characters
This is the bank account number.
Possible values: >= 9 characters
and <= 9 characters
For USD accounts, this is the 9-digit routing number of the bank.
Bank name.
Possible values: [SAVINGS
, CHECKING
, LOAN
]
Possible values: >= 20 characters
and <= 20 characters
A bank account number (Código de Cuenta Interbancario), has 20 digits
Is the instrument externally verified. The property is not returned by the API anymore.
Possible values: [VERIFIED
, UNVERIFIED
, VERIFICATION_REQUIRED
, REJECTED
]
Instrument status.
Represents RFC 3339, section 5.6 date-time.
Instrument creation time.
Possible values: [NATIONALITY
, OCCUPATION
, MOBILE
]
List of not completed attributes required for full customer onboarding.
{
"id": "string",
"title": "Mr.",
"firstName": "John",
"lastName": "Doe",
"birthDate": "1981-01-11",
"nationality": "GB",
"occupation": "ARCHITECTURE_CARTOGRAPHY_SURVEYOR",
"vulnerabilities": [
"PHYSICAL_DISABILITY",
"LOW_MENTAL_CAPACITY"
],
"externalId": "a2322550-af91-417f-867e-681efad44b9d",
"address": {
"countryCode": "GB",
"stateProvince": "string",
"city": "string",
"postalCode": "string",
"address1": "string",
"address2": "string"
},
"contactInfo": {
"mobile": "string",
"email": "user@example.com"
},
"type": "string",
"restrictions": [
{
"name": "ALL_TRANSACTIONS",
"requiredActions": [
"CONTACT_CUSTOMER_SERVICE",
"KYC_VERIFICATION"
],
"lastChangeDate": "2021-07-15T17:54:12Z",
"id": "34fe6de4-e162-484c-b5e9-05a79e889110",
"activationTime": "2021-07-15T17:54:12Z",
"dueDate": "2021-07-15T17:54:12Z"
}
],
"accounts": [
{
"currencyCode": "EUR",
"id": "5029090724",
"customerId": "123456789",
"externalId": "a2322550-af91-417f-867e-681efad44b9d",
"totalBalance": 0,
"availableBalance": 0,
"instruments": [
{
"id": "string",
"customerId": "5435323362",
"instrumentType": "CARD",
"status": "VERIFIED",
"creationTime": "2021-07-15T17:54:12Z"
}
],
"creationTime": "2019-08-24T14:15:22Z"
}
],
"incompleteAttributes": [
"OCCUPATION"
]
}
{
"id": "5435323362",
"type": "PERSON",
"title": "Mr",
"firstName": "John",
"lastName": "Doe",
"birthDate": "2019-08-24",
"nationality": "GB",
"occupation": "ARCHITECTURE_CARTOGRAPHY_SURVEYOR",
"vulnerabilities": [
"PHYSICAL_DISABILITY",
"LOW_MENTAL_CAPACITY"
],
"contactInfo": {
"email": "john.doe@paysafe.com",
"mobile": "+359897765463"
},
"address": {
"countryCode": "GB",
"stateProvince": "AZ",
"city": "New York",
"postalCode": "1200",
"address1": "13th Street.",
"address2": "17th Street"
},
"accounts": [
{
"currencyCode": "EUR",
"id": "5435323361",
"customerId": "5435323362",
"externalId": "a2322550-af91-417f-867e-681efad44b9d",
"totalBalance": 0,
"availableBalance": 0,
"instruments": [],
"creationTime": "2019-08-24T14:15:22Z"
}
],
"restrictions": [
{
"name": "ALL_TRANSACTIONS",
"requiredActions": [
"KYC_VERIFICATION"
],
"lastChangeDate": "2021-07-15T17:54:12Z",
"id": "9d487890-6cc5-442e-bd4f-fd025a82f1f7",
"activationTime": "2021-07-15T17:54:12Z",
"dueDate": "2021-07-15T17:54:12Z"
}
],
"incompleteAttributes": [
"OCCUPATION"
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- INVALID_DATA
- FORBIDDEN_COUNTRY
- RISK_ENGINE_DECLINED_ONBOARDING
- VERIFICATION_NOT_COMPLETED
Schema
Array [
]
error
object
Additional details about the error.
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-CUSTOMER-BAD-REQUEST",
"message": "Bad request",
"details": [
"Bad request for customer operation"
],
"fieldErrors": [
{
"field": "birthDate | firstName | etc.",
"error": "birthDate | firstName | etc. is invalid."
}
]
}
}
{
"error": {
"code": "DW-CUSTOMER-IP-COUNTRY-SANCTIONED",
"message": "Country of IP address not allowed",
"details": [
"Customer's IP country falls into the list of sanctioned countries."
]
}
}
{
"error": {
"code": "DW-REGISTRATION-DECLINED-BY-RISK-ENGINE",
"message": "Registration declined",
"details": [
"Registration declined by the Risk engine."
]
}
}
{
"error": {
"code": "DW-CUSTOMER-DATA-VERIFICATION-NOT-COMPLETED",
"message": "Customer not passed data verification",
"details": [
"Customer identifiers must be verified."
]
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- INVALID_CREDENTIALS
Schema
Array [
]
error
object
Additional details about the error.
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "5279",
"message": "Invalid credentials",
"details": [
"The authentication credentials are invalid."
]
}
}
Conflict
- application/json
- Schema
- Example (from schema)
- CUSTOMER_ALREADY_ONBOARDED
- MOBILE_NUMBER_ALREADY_EXISTS
Schema
Array [
]
error
object
Additional details about the error.
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-CUSTOMER-ALREADY-ONBOARDED",
"message": "Customer with the same details has already been onboarded.",
"details": [
"Customer with the same details has already been onboarded."
]
}
}
{
"error": {
"code": "DW-ATTRIBUTE-ALREADY-EXISTS",
"message": "Customer attribute already exists",
"details": [
"Customer with given attribute already exists."
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- INTERNAL_SERVER_ERROR
Schema
Array [
]
error
object
Additional details about the error.
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-INTERNAL-SERVER-ERROR",
"message": "Internal Server Error",
"details": [
"There was an error while processing the operation"
]
}
}
Service Unavailable
- application/json
- Schema
- Example (from schema)
- SERVICE_UNAVAILABLE
Schema
Array [
]
error
object
Additional details about the error.
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-SERVICE-UNAVAILABLE",
"message": "Service Unavailable",
"details": [
"Service Unavailable"
]
}
}