Get Profile

GET 
/profile

Returns profile information for the logged in customer.

By default limited information is returned. Use include parameter to add additional information into the response:

• ACCOUNTS - include account balance information
• RESTRICTIONS - include restriction information
• ADDRESS - include address information
• CONTACTINFO - include contact information
• INCOMPLETE_ONBOARDING_ATTRIBUTES - include incomplete onboarding attributes

Request

Query Parameters

include ProfileIncludes[]

Possible values: [ACCOUNTS, RESTRICTIONS, ADDRESS, CONTACTINFO, INCOMPLETE_ONBOARDING_ATTRIBUTES]

Include listed properties in the response.

Responses

200

OK

application/json

Schema

Schema

id string

Possible values: <= 20 characters

Paysafe embedded wallet internal identifier.

title string

Possible values: <= 15 characters

Personal title, Mr., Dr., etc.

firstName stringrequired

Possible values: <= 50 characters

First name.

lastName stringrequired

Possible values: <= 50 characters

Last name.

birthDate daterequired

Birth date in YYYY-MM-DD format.

nationality CountryCode (string)

Possible values: >= 2 characters and <= 2 characters

ISO-3166 Alpha 2

occupation Occupation (string)
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:
• 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"
vulnerabilities Vulnerability (string)[]

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.

externalId ExternalId (string)

Possible values: non-empty and <= 40 characters

External identifier in merchant system. Must be passed during onboarding.

address

object

countryCode CountryCode (string)required

Possible values: >= 2 characters and <= 2 characters

ISO-3166 Alpha 2

stateProvince string

Possible values: <= 2 characters

US state postal abbreviation. Not used for non US territories.

city stringrequired

Possible values: <= 50 characters

postalCode stringrequired

Possible values: non-empty and <= 50 characters

address1 stringrequired

Possible values: <= 200 characters

address2 string

Possible values: <= 200 characters

contactInfo

object

Contact information

mobile string

Mobile number

email email

Email

type string

Type of Customer

restrictions

object[]

Restrictions placed on the customer.

Array [

name RestrictionName (string)required

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.

• 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.

requiredActions RequiredAction (string)[]

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

lastChangeDate date-time

Represents RFC 3339, section 5.6 date-time.

id stringrequired

Restriction id

activationTime date-time

Represents RFC 3339, section 5.6 date-time.

dueDate date-time

Represents RFC 3339, section 5.6 date-time.

]

accounts

object[]

Accounts associated with this customer.

Array [

currencyCode Currency (string)required

Possible values: >= 3 characters and <= 3 characters

Currency alphabetic code as specified by ISO 4217

id string

Possible values: <= 20 characters

Account id.

customerId string

Possible values: <= 20 characters

Paysafe embedded wallet internal customer identifier.

externalId ExternalId (string)

Possible values: non-empty and <= 40 characters

External identifier in merchant system. Must be passed during onboarding.

totalBalance int64

Amount in minor units

availableBalance int64

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.

Array [

id string

The instrument id

customerId string

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

pan stringrequired

Card Number

cardHolderName string

Possible values: <= 160 characters

Card holder name.

bankName string

Bank name.

expiryDate

object

required

Card expiry date.

year integerrequired

month integerrequired

cardScheme CardScheme (string)

Possible values: [VISA, MC]

Card scheme information.

• VISA - VISA
• MC - Mastercard The scheme is derived from the card PAN.

description string

Possible values: <= 20 characters

Name to be associated with the card.

SEPA_BANK_ACCOUNT

accountHolderName string

Possible values: <= 100 characters

This is the name of the customer or company that owns the bank account.

iban stringrequired

The International Bank Account Number (IBAN) of the account.

bic stringrequired

The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.

bankName string

Bank name.

UK_BANK_ACCOUNT

accountHolderName string

Possible values: <= 100 characters

This is the name of the customer or company that owns the bank account.

accountNumber stringrequired

A bank account number.

sortCode stringrequired

Use our sort code checker to easily find and check UK sort codes.

bankName string

Bank name.

US_BANK_ACCOUNT

accountHolderName string

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.

accountNumber stringrequired

Possible values: >= 4 characters and <= 17 characters

This is the bank account number.

routingNumber stringrequired

Possible values: >= 9 characters and <= 9 characters

For USD accounts, this is the 9-digit routing number of the bank.

bankName string

Bank name.

accountType string

Possible values: [SAVINGS, CHECKING, LOAN]

CCI_BANK_ACCOUNT

accountNumber stringrequired

Possible values: >= 20 characters and <= 20 characters

A bank account number (Código de Cuenta Interbancario), has 20 digits

externallyVerified booleandeprecated

Is the instrument externally verified. The property is not returned by the API anymore.

status string

Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

Instrument status.

creationTime date-time

Represents RFC 3339, section 5.6 date-time.

]

creationTime date-time

Instrument creation time.

]

incompleteAttributes IncompleteAttribute (string)[]

Possible values: [NATIONALITY, OCCUPATION, MOBILE]

List of not completed attributes required for full customer onboarding.

Example (from schema)

{
  "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"
  ]
}

CustomerInfo

{
  "id": "1111",
  "externalId": "external_1111",
  "type": "PERSON",
  "contactInfo": {
    "email": "john.smith@mail.com",
    "mobile": "0012025550117"
  },
  "restrictions": [
    {
      "name": "ALL_TRANSACTIONS",
      "requiredActions": [
        "KYC_VERIFICATION"
      ],
      "lastChangeDate": "2021-07-15T17:54:12Z",
      "id": "1234"
    }
  ],
  "accounts": [
    {
      "currencyCode": "USD",
      "id": "12345",
      "customerId": "1111",
      "externalId": "external_1111",
      "totalBalance": 0,
      "availableBalance": 0,
      "instruments": [],
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "title": "mr",
  "firstName": "John",
  "lastName": "Smith",
  "birthDate": "2000-08-24",
  "nationality": "US",
  "occupation": "DOMESTIC_SERVICES",
  "vulnerabilities": [
    "PHYSICAL_DISABILITY",
    "LOW_MENTAL_CAPACITY"
  ],
  "address": {
    "countryCode": "US",
    "stateProvince": "TX",
    "city": "Dallas",
    "postalCode": "75231",
    "address1": "10455 N Central Expy"
  },
  "incompleteAttributes": []
}

401

Unauthorized

application/json

Schema

Schema

error

object

Additional details about an error

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

UNAUTHORIZED

{
  "error": {
    "code": "5275",
    "message": "Authentication credentials expired",
    "details": [
      "The authentication credentials have expired."
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Additional details about an error

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INTERNAL_SERVER_ERROR

{
  "error": {
    "code": "DW-INTERNAL-SERVER-ERROR",
    "message": "Internal Server Error",
    "details": [
      "There was an error while processing the operation"
    ]
  }
}

503

Service Unavailable. Please try again later.

application/json

Schema

Schema

error

object

Additional details about an error

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

SERVICE_UNAVAILABLE

{
  "error": {
    "code": "DW-SERVICE-UNAVAILABLE",
    "message": "Service Unavailable",
    "details": [
      "Service Unavailable"
    ]
  }
}

Loading...