Participants

Participants represent a buyer or seller in the trustshare API.

In most cases, participants receiving funds from Projects are required to be verified using a Verification.

You can either create, and verify, participants up-front or you can create them lazily as part of a Payment Intent. In either case, you can provide as much, or as little, information about the participant as you wish. The only requirement is at least an email address. The more information you provide during the creation of a participant, the less information the participant will have to provide during the verification process.

The email address is the primary identifier for a participant, you can create as many participants with the same email address as you like. You will find that depending on the level of provided information you may receive a different unique identifier than you had previously. This is expected, and using any ID related to a specific email address will work. Verification for a specific email address is inherited across all associated participants.

The system will endeavour to automatically verify a participant receiving funds at the point of release, if they are not already verified.

Bank account details

Knowing which bank credentials to provide for a country and currency combination is tricky. You can use our payout support endpoint to quickly query for which details you need.

The participant model

The participant object provides a representation of a buyer or seller within the trustshare API, including their verification status, default bank account and associated metadata.

Properties

  • Name
    id
    Type
    string
    Description

    A unique ID of the participant.

    A string in the format: participant_[0-9a-z].

  • Name
    status
    Type
    enum
    Description

    unverified verifying verified

    The participant status.

  • Name
    type
    Type
    enum
    Description

    unknown individual business third_party organisation

    The participant type.

  • Name
    email
    Type
    string
    Description

    The participant's email.

  • Name
    name
    Type
    string
    Description

    The participant's name.

  • Name
    address
    Type
    object
    Description

    An object describing the participant's address.

    • Name
      type
      Type
      enum
      Description

      unknown shipping billing residential registered trading

      The address's type.

    • Name
      address_line_1
      Type
      string
      Description

      First line of the address.

    • Name
      address_line_2
      Type
      string
      Description

      Second line of the address.

    • Name
      town_city
      Type
      string
      Description

      The town/city of the address.

    • Name
      region
      Type
      string
      Description

      The region of the address.

    • Name
      postal_code
      Type
      string
      Description

      The postal code of the address.

    • Name
      country
      Type
      enum
      Description

      AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

      The country code of the address.

    An object describing the participant's address.

  • Name
    bank_account
    Type
    object
    Description

    An object describing the participant's bank account.

    • Name
      id
      Type
      string
      Description

      A unique ID for the bank_account.

      A string in the format bank_account_[0-9a-z].

    • Name
      country
      Type
      enum
      Description

      AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

      The country the bank account is held in.

    • Name
      currency
      Type
      enum
      Description

      aed afn all amd ang aoa ars aud awg azn bam bbd bdt bgn bhd bif bmd bnd bob brl bsd btn bwp byn bzd cad cdf chf clp cny cop crc cup cve czk djf dkk dop dzd egp ern etb eur fjd fkp gbp gel ghs gip gmd gnf gtq gyd hkd hnl hrk htg huf idr ils inr iqd irr isk jmd jod jpy kes kgs khr kmf kpw krw kwd kyd kzt lak lbp lkr lrd lsl ltl lvl lyd mad mdl mga mkd mmk mnt mop mro mur mvr mwk mxn myr mzn nad ngn nio nok npr nzd omr pab pen pgk php pkr pln pyg qar ron rsd rub rwf sar sbd scr sdg sek sgd shp sll sos srd ssp std syp szl thb tjs tmt tnd top try ttd tvd twd tzs uah ugx usd uyu uzs ved vnd vuv wst xaf xcd xof xpf yer zar zmw

      The currency the bank account is held in.

    • Name
      account_number
      Type
      string
      Description

      The account number of the bank account.

    • Name
      routing_code
      Type
      string
      Description

      The routing code of the bank account.

    • Name
      routing_code_type
      Type
      enum
      Description

      bic_swift aba clabe cnaps wire ach bank_code ifsc sort_code

      The routing code type of the bank account.

    • Name
      routing_data
      Type
      object
      Description

      An object potentially containing further routing data.

    An object describing the participant's bank account.

  • Name
    business
    Type
    object
    Description

    An object describing the participant's business details.

    • Name
      type
      Type
      enum
      Description

      unknown limited public partnership sole_trader

      The type of business.

    • Name
      company_number
      Type
      string
      Description

      The business' company number.

    • Name
      registered_address
      Type
      object
      Description

      The business' registered address.

      • Name
        type
        Type
        enum
        Description

        unknown shipping billing residential registered trading

        The address's type.

      • Name
        address_line_1
        Type
        string
        Description

        First line of the address.

      • Name
        address_line_2
        Type
        string
        Description

        Second line of the address.

      • Name
        town_city
        Type
        string
        Description

        The town/city of the address.

      • Name
        region
        Type
        string
        Description

        The region of the address.

      • Name
        postal_code
        Type
        string
        Description

        The postal code of the address.

      • Name
        country
        Type
        enum
        Description

        AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

        The country code of the address.

      The business' registered address.

    • Name
      trading_address
      Type
      object
      Description

      The business' trading address.

      • Name
        type
        Type
        enum
        Description

        unknown shipping billing residential registered trading

        The address's type.

      • Name
        address_line_1
        Type
        string
        Description

        First line of the address.

      • Name
        address_line_2
        Type
        string
        Description

        Second line of the address.

      • Name
        town_city
        Type
        string
        Description

        The town/city of the address.

      • Name
        region
        Type
        string
        Description

        The region of the address.

      • Name
        postal_code
        Type
        string
        Description

        The postal code of the address.

      • Name
        country
        Type
        enum
        Description

        AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

        The country code of the address.

      The business' trading address.

    • Name
      shipping_address
      Type
      object
      Description

      The business' shipping address.

      • Name
        type
        Type
        enum
        Description

        unknown shipping billing residential registered trading

        The address's type.

      • Name
        address_line_1
        Type
        string
        Description

        First line of the address.

      • Name
        address_line_2
        Type
        string
        Description

        Second line of the address.

      • Name
        town_city
        Type
        string
        Description

        The town/city of the address.

      • Name
        region
        Type
        string
        Description

        The region of the address.

      • Name
        postal_code
        Type
        string
        Description

        The postal code of the address.

      • Name
        country
        Type
        enum
        Description

        AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

        The country code of the address.

      The business' shipping address.

    • Name
      phone_number
      Type
      string
      Description

      The business' phone number.

    • Name
      website
      Type
      string
      Description

      The business' website.

    • Name
      persons
      Type
      object[]
      Description

      A list of the business' employees with significant control.

      • Name
        type
        Type
        enum
        Description

        unknown shareholder director partner applicant executive

        The person's type.

      • Name
        name
        Type
        string
        Description

        The person's name.

      • Name
        address
        Type
        object
        Description

        The person's address.

        • Name
          type
          Type
          enum
          Description

          unknown shipping billing residential registered trading

          The address's type.

        • Name
          address_line_1
          Type
          string
          Description

          First line of the address.

        • Name
          address_line_2
          Type
          string
          Description

          Second line of the address.

        • Name
          town_city
          Type
          string
          Description

          The town/city of the address.

        • Name
          region
          Type
          string
          Description

          The region of the address.

        • Name
          postal_code
          Type
          string
          Description

          The postal code of the address.

        • Name
          country
          Type
          enum
          Description

          AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

          The country code of the address.

        The person's address.

      • Name
        email
        Type
        string
        Description

        The person's email address.

      • Name
        phone_number
        Type
        string
        Description

        The person's phone number.

      • Name
        date_of_birth
        Type
        string
        Description

        The person's date of birth.

      A list of the business' employees with significant control.

    An object describing the participant's business details.

  • Name
    individual
    Type
    object
    Description

    An object describing the participant's individual details.

    • Name
      date_of_birth
      Type
      string
      Description

      The individual's date of birth.

    • Name
      residential_address
      Type
      object
      Description

      The individual's residential address.

      • Name
        type
        Type
        enum
        Description

        unknown shipping billing residential registered trading

        The address's type.

      • Name
        address_line_1
        Type
        string
        Description

        First line of the address.

      • Name
        address_line_2
        Type
        string
        Description

        Second line of the address.

      • Name
        town_city
        Type
        string
        Description

        The town/city of the address.

      • Name
        region
        Type
        string
        Description

        The region of the address.

      • Name
        postal_code
        Type
        string
        Description

        The postal code of the address.

      • Name
        country
        Type
        enum
        Description

        AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

        The country code of the address.

      The individual's residential address.

    • Name
      shipping_address
      Type
      object
      Description

      The individual's shipping address.

      • Name
        type
        Type
        enum
        Description

        unknown shipping billing residential registered trading

        The address's type.

      • Name
        address_line_1
        Type
        string
        Description

        First line of the address.

      • Name
        address_line_2
        Type
        string
        Description

        Second line of the address.

      • Name
        town_city
        Type
        string
        Description

        The town/city of the address.

      • Name
        region
        Type
        string
        Description

        The region of the address.

      • Name
        postal_code
        Type
        string
        Description

        The postal code of the address.

      • Name
        country
        Type
        enum
        Description

        AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

        The country code of the address.

      The individual's shipping address.

    • Name
      phone_number
      Type
      string
      Description

      The individual's phone number.

    An object describing the participant's individual details.

  • Name
    organisation
    Type
    object
    Description

    An object describing the participant's organisation details.

    • Name
      type
      Type
      enum
      Description

      unknown overseas_government treaty non_profit political voluntary_group sports_club other

      The type of organisation.

    • Name
      organisation_number
      Type
      string
      Description

      The organisation's registered number.

    • Name
      registered_address
      Type
      object
      Description

      The organisation's registered address.

      • Name
        type
        Type
        enum
        Description

        unknown shipping billing residential registered trading

        The address's type.

      • Name
        address_line_1
        Type
        string
        Description

        First line of the address.

      • Name
        address_line_2
        Type
        string
        Description

        Second line of the address.

      • Name
        town_city
        Type
        string
        Description

        The town/city of the address.

      • Name
        region
        Type
        string
        Description

        The region of the address.

      • Name
        postal_code
        Type
        string
        Description

        The postal code of the address.

      • Name
        country
        Type
        enum
        Description

        AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

        The country code of the address.

      The organisation's registered address.

    • Name
      shipping_address
      Type
      object
      Description

      The organisation's shipping address.

      • Name
        type
        Type
        enum
        Description

        unknown shipping billing residential registered trading

        The address's type.

      • Name
        address_line_1
        Type
        string
        Description

        First line of the address.

      • Name
        address_line_2
        Type
        string
        Description

        Second line of the address.

      • Name
        town_city
        Type
        string
        Description

        The town/city of the address.

      • Name
        region
        Type
        string
        Description

        The region of the address.

      • Name
        postal_code
        Type
        string
        Description

        The postal code of the address.

      • Name
        country
        Type
        enum
        Description

        AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

        The country code of the address.

      The organisation's shipping address.

    • Name
      phone_number
      Type
      string
      Description

      The organisation's phone number.

    • Name
      website
      Type
      string
      Description

      The organisation's website.

    • Name
      persons
      Type
      object[]
      Description

      The organisation's members with significant control.

      • Name
        type
        Type
        enum
        Description

        unknown shareholder director partner applicant executive

        The person's type.

      • Name
        name
        Type
        string
        Description

        The person's name.

      • Name
        address
        Type
        object
        Description

        The person's address.

        • Name
          type
          Type
          enum
          Description

          unknown shipping billing residential registered trading

          The address's type.

        • Name
          address_line_1
          Type
          string
          Description

          First line of the address.

        • Name
          address_line_2
          Type
          string
          Description

          Second line of the address.

        • Name
          town_city
          Type
          string
          Description

          The town/city of the address.

        • Name
          region
          Type
          string
          Description

          The region of the address.

        • Name
          postal_code
          Type
          string
          Description

          The postal code of the address.

        • Name
          country
          Type
          enum
          Description

          AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

          The country code of the address.

        The person's address.

      • Name
        email
        Type
        string
        Description

        The person's email address.

      • Name
        phone_number
        Type
        string
        Description

        The person's phone number.

      • Name
        date_of_birth
        Type
        string
        Description

        The person's date of birth.

      The organisation's members with significant control.

    An object describing the participant's organisation details.

  • Name
    metadata
    Type
    object
    Description

    The metadata that was provided at the creation of the participant.

Example

{
  "id": "participant_eHTQstcsRb",
  "status": "unverified",
  "email": "sink+buyer@trustshare.co",
  "type": "unknown",
  "name": "Tester Dude",
  "address": {
    "type": "residential",
    "address_line_1": "23 The Road",
    "address_line_2": null,
    "town_city": "London",
    "region": "Greater London",
    "postal_code": "N22 6TY",
    "country": "GB"
  },
  "bank_account": {
    "id": "bank_account_8pEw9AmBhX",
    "country": "GB",
    "currency": "gbp",
    "account_number": "12345465",
    "routing_code": "122343",
    "routing_code_type": "sort_code",
    "routing_data": {}
  },
  "business": null,
  "individual": null,
  "organisation": null,
  "metadata": {
    "foo": "could store my metadata"
  }
}

GET/v1/participant/{id}

Get a Participant

Retrieve an existing participant.

Required attributes

  • Name
    id
    Type
    string
    Required
    Required
    Description

    A unique ID of an existing participant.

    A string in the format: participant_[0-9a-z]

Request

GET
/v1/participant/participant_eHTQstcsRb
curl https://rest.trustshare.io/v1/participant/participant_eHTQstcsRb \ 
  -H "Authorization: <private_key>"

GET/v1/support/payout

Get Payout Support

Given a country/currency pairing, returns whether the pair is supported along with the required fields that must be provided to the API when including a bank account.

Required attributes

  • Name
    country
    Type
    enum
    Required
    Required
    Description

    AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

    The country the bank account is held in.

  • Name
    currency
    Type
    enum
    Required
    Required
    Description

    aed afn all amd ang aoa ars aud awg azn bam bbd bdt bgn bhd bif bmd bnd bob brl bsd btn bwp byn bzd cad cdf chf clp cny cop crc cup cve czk djf dkk dop dzd egp ern etb eur fjd fkp gbp gel ghs gip gmd gnf gtq gyd hkd hnl hrk htg huf idr ils inr iqd irr isk jmd jod jpy kes kgs khr kmf kpw krw kwd kyd kzt lak lbp lkr lrd lsl ltl lvl lyd mad mdl mga mkd mmk mnt mop mro mur mvr mwk mxn myr mzn nad ngn nio nok npr nzd omr pab pen pgk php pkr pln pyg qar ron rsd rub rwf sar sbd scr sdg sek sgd shp sll sos srd ssp std syp szl thb tjs tmt tnd top try ttd tvd twd tzs uah ugx usd uyu uzs ved vnd vuv wst xaf xcd xof xpf yer zar zmw

    The currency the bank account is held in.

Request

GET
/v1/support/payout?country=GB&currency=gbp
curl -G https://rest.trustshare.io/v1/support/payout \ 
  -d country=GB \ 
  -d currency=gbp

Response

{
  "country": "GB",
  "currency": "gbp",
  "supported": true,
  "requirements": [
    "account_number",
    "sort_code"
  ]
}

POST/v1/participants

Create a Participant

Optionally, you can pre-create a participant to use in an intent. The returned unique ID should be used in the intent creation call. The minimum requirement for creating a participant is an email address.

Required attributes

  • Name
    email
    Type
    string
    Required
    Required
    Description

    The email of the participant.

Optional attributes

  • Name
    name
    Type
    string
    Description

    The name of the participant.

  • Name
    type
    Type
    enum
    Description

    unknown individual business third_party organisation

    The type of the participant.

  • Name
    address
    Type
    object
    Description

    An object describing the address of the participant.

    • Name
      type
      Type
      enum
      Description

      unknown shipping billing residential registered trading

      The type of the address, defaults to unknown.

    • Name
      address_line_1
      Type
      string
      Required
      Required
      Description

      First line of the address.

    • Name
      address_line_2
      Type
      string
      Description

      Second line of the address.

    • Name
      town_city
      Type
      string
      Required
      Required
      Description

      The town/city of the address.

    • Name
      region
      Type
      string
      Description

      The region of the address.

    • Name
      postal_code
      Type
      string
      Required
      Required
      Description

      The postal code of the address.

    • Name
      country
      Type
      enum
      Required
      Required
      Description

      AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

      The country code of the address.

    An object describing the address of the participant.

  • Name
    bank_account
    Type
    object
    Description

    An object describing the bank account of the participant.

    • Name
      country
      Type
      enum
      Required
      Required
      Description

      AD AE AF AG AI AL AM AO AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GG GH GI GL GM GN GQ GR GS GT GU GW GY HK HN HR HT HU ID IE IL IM IN IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PN PR PS PT PW PY QA RO RS RU RW SA SB SC SD SE SG SH SI SK SL SM SN SO SR SS ST SV SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

      The country the bank account is held in.

    • Name
      currency
      Type
      enum
      Required
      Required
      Description

      aed afn all amd ang aoa ars aud awg azn bam bbd bdt bgn bhd bif bmd bnd bob brl bsd btn bwp byn bzd cad cdf chf clp cny cop crc cup cve czk djf dkk dop dzd egp ern etb eur fjd fkp gbp gel ghs gip gmd gnf gtq gyd hkd hnl hrk htg huf idr ils inr iqd irr isk jmd jod jpy kes kgs khr kmf kpw krw kwd kyd kzt lak lbp lkr lrd lsl ltl lvl lyd mad mdl mga mkd mmk mnt mop mro mur mvr mwk mxn myr mzn nad ngn nio nok npr nzd omr pab pen pgk php pkr pln pyg qar ron rsd rub rwf sar sbd scr sdg sek sgd shp sll sos srd ssp std syp szl thb tjs tmt tnd top try ttd tvd twd tzs uah ugx usd uyu uzs ved vnd vuv wst xaf xcd xof xpf yer zar zmw

      The currency the bank account is held in.

    • Name
      account_number
      Type
      string
      Description

      The account number of the bank account.

    • Name
      iban
      Type
      string
      Description

      The IBAN of the bank account.

    • Name
      aba
      Type
      string
      Description

      The ABA routing code of the bank account (US only).

    • Name
      bank_code
      Type
      string
      Description

      The Bank Code of the bank account.

    • Name
      bic_swift
      Type
      string
      Description

      The Bank Identifier Code of the bank account on the SWIFT network.

    • Name
      branch_code
      Type
      string
      Description

      The Branch Code of the bank account.

    • Name
      bsb_code
      Type
      string
      Description

      The BSB code of the bank account (AU only).

    • Name
      clabe
      Type
      string
      Description

      The CLABE of the bank account (MX only).

    • Name
      cnaps
      Type