SOsoldo
Contacts

Get Contact

Changed on

Endpoint to get specific Contact by ID.

get/business/v2/contacts/{contactId}

Request

Path parameters

contactIdstring required

The Contact ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

Response

The returned resource is a single Contact.

idstring

The Contact ID.

namestring

The name of the Contact.

user_idstring

The ID of the User the Contact is assigned to (only for Contacts of type EMPLOYEE).

type'SUPPLIER' | 'CLIENT' | 'EMPLOYEE' | 'ACCOUNT'
payment_schemePaymentSchema[]

The payment schemes that can be used to pay the Contact.

bicstring

The BIC (SWIFT code) of the bank of the Contact, if provided.

country'ASC' | 'AND' | 'ARE' | 'AFG' | 'ATG' | 'AIA' | 'ALB' | 'ARM' | 'ANT' | 'AGO' | 'ATA' | 'ARG' | 'ASM' | 'AUT' | 'AUS' | 'ABW' | 'ALA' | 'AZE' | 'BIH' | 'BRB' | 'BGD' | 'BEL' | 'BFA' | 'BGR' | 'BHR' | 'BDI' | 'BEN' | 'BLM' | 'BMU' | 'BRN' | 'BOL' | 'BES' | 'BRA' | 'BHS' | 'BTN' | 'BUR' | 'BVT' | 'BWA' | 'BLR' | 'BLZ' | 'CAN' | 'CCK' | 'COD' | 'CAF' | 'COG' | 'CHE' | 'CIV' | 'COK' | 'CHL' | 'CMR' | 'CHN' | 'COL' | 'CPT' | 'CRI' | 'CSXX' | 'CUB' | 'CPV' | 'CUW' | 'CXR' | 'CYP' | 'CZE' | 'DEU' | 'DGA' | 'DJI' | 'DNK' | 'DMA' | 'DOM' | 'DZA' | 'ECU' | 'EST' | 'EGY' | 'ESH' | 'ERI' | 'ESP' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FSM' | 'FRO' | 'FRA' | 'FXX' | 'GAB' | 'GBR' | 'GRD' | 'GEO' | 'GUF' | 'GGY' | 'GHA' | 'GIB' | 'GRL' | 'GMB' | 'GIN' | 'GLP' | 'GNQ' | 'GRC' | 'SGS' | 'GTM' | 'GUM' | 'GNB' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IRL' | 'ISR' | 'IMN' | 'IND' | 'IOT' | 'IRQ' | 'IRN' | 'ISL' | 'ITA' | 'JEY' | 'JAM' | 'JOR' | 'JPN' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'COM' | 'KNA' | 'PRK' | 'KOR' | 'KWT' | 'CYM' | 'KAZ' | 'LAO' | 'LBN' | 'LCA' | 'LIE' | 'LKA' | 'LBR' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'LBY' | 'MAR' | 'MCO' | 'MDA' | 'MNE' | 'MAF' | 'MDG' | 'MHL' | 'MKD' | 'MLI' | 'MMR' | 'MNG' | 'MAC' | 'MNP' | 'MTQ' | 'MRT' | 'MSR' | 'MLT' | 'MUS' | 'MDV' | 'MWI' | 'MEX' | 'MYS' | 'MOZ' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NTZ' | 'NIU' | 'NZL' | 'OMN' | 'PAN' | 'PER' | 'PYF' | 'PNG' | 'PHL' | 'PAK' | 'POL' | 'SPM' | 'PCN' | 'PRI' | 'PSE' | 'PRT' | 'PLW' | 'PRY' | 'QAT' | 'REU' | 'ROU' | 'ROM' | 'SRB' | 'RUS' | 'RWA' | 'SAU' | 'SLB' | 'SYC' | 'SDN' | 'SWE' | 'SGP' | 'SHN' | 'SVN' | 'SJM' | 'SVK' | 'SLE' | 'SMR' | 'SEN' | 'SOM' | 'SUR' | 'SSD' | 'STP' | 'SUN' | 'SLV' | 'SXM' | 'SYR' | 'SWZ' | 'TAA' | 'TCA' | 'TCD' | 'ATF' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TLS' | 'TKM' | 'TUN' | 'TON' | 'TUR' | 'TTO' | 'TUV' | 'TWN' | 'TZA' | 'UKR' | 'UGA' | 'UMI' | 'USA' | 'URY' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'XKX' | 'XXK' | 'QZZ' | 'YEM' | 'MYT' | 'YUCS' | 'ZAF' | 'ZMB' | 'ZRCD' | 'ZWE'
status'CREATED' | 'SUGGESTED'
creation_timestring

The date and time when the Contact was created.

last_update_timestring

The date and time when the Contact was last updated.

bank_account_verification_status'UNABLE_TO_MATCH' | 'FULL_MATCH' | 'PARTIAL_MATCH' | 'NO_MATCH' | 'UNABLE_TO_VERIFY'

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "name": "John Doe",
  "user_id": "XMPL1234-000001",
  "account_info": [
    {
      "identification": "GB00ABCD00000123456789"
    }
  ],
  "bic": "UNCRITMMXXX",
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update_time": "2017-06-01T12:48:40Z",
  "validation": {
    "field": "name",
    "current_value": "JAMES ADAN",
    "suggested_value": "JAMES ADAM"
  }
}

Changes

  • 23fc5d07b367Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 7be21448a2b3Revision changes
    • warning

      added the new QZZ enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status