Verifications

Verifications represent the process of verifying a Participant on the trustshare API. Only participants who are required to receive funds need to be verified.

Verifications are based on an opt-out model. This means you do not need to pre-verify or enroll your participants before transactions can take place. The verification flow is pushed to the last possible point during the payment life cycle. Sellers are always verified on the system, but we are automatically able to accept payments intended for them.

We create system-initiated verifications the first time a participant is targeted in an Outbound. If you wish to verify a participant for your own purposes you can manually create a verification. By providing as much information as you can, you can reduce the friction during the verify process for your users.

Confirming a verification

To complete a verification, the user must go through a front-end driven process on the trustshare system. The client_secret provided on the verification object should be passed to the SDK.

The UI presented to the user will reflect the status of the verification. For example, a completed verification process will always just show the Complete Screen, preventing the user from taking any further actions.

Confirming a verification on the user's device

import createSDK from '@trustshare/sdk';

const truatshare = createSDK('<public_key>');

await trustshare.sdk.v1.confirmVerification(client_secret);

The verification model

The verification object provides a representation of the process a Participant takes to receive funds within the trustshare API, including their verification status, and associated metadata.

Properties

  • Name
    id
    Type
    string
    Description

    A unique ID of the verification.

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

  • Name
    type
    Type
    enum
    Description

    unknown individual organisation business limited public partnership sole_trader overseas_government treaty non_profit political voluntary_group sports_club other

    The type of entity this verification describes.

  • Name
    status
    Type
    enum
    Description

    required partially_submitted id_verification_required automated_review manual_review passed failed

    The verification status.

  • Name
    participant
    Type
    object
    Description

    An object describing the participant to be verified.

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

    An object describing the participant to be verified.

  • Name
    client_secret
    Type
    string
    Description

    The client secret for the verification.

  • Name
    redirect_url
    Type
    string
    Description

    The redirect URL supplied at the creation of the verification.

  • Name
    metadata
    Type
    object
    Description

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

Example

{
  "id": "verification_QLDAI2oPpm",
  "type": "individual",
  "status": "required",
  "participant": {
    "id": "participant_S15J7WrBQJ",
    "status": "unverified",
    "email": "sink+seller@trustshare.co",
    "type": "individual",
    "name": "Rufus McGuire",
    "address": {
      "type": "unknown",
      "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_tUKVDdAItY",
      "country": "GB",
      "currency": "gbp",
      "account_number": "01139097",
      "routing_code": "309455",
      "routing_code_type": "sort_code",
      "routing_data": {}
    },
    "business": null,
    "individual": null,
    "organisation": null,
    "metadata": {}
  },
  "client_secret": "sandbox_v_BcAtzjWl8snjr2QhdCSLpunSKhv6pom9Zx0ugsDvNjQLBxmf2f7JgXAZKpCGWUQD",
  "metadata": {
    "foo": "managed to store my meta on VERIFICATION"
  }
}

GET/v1/verification/{id}

Get a Verification

Retrieve an existing verification.

Required attributes

  • Name
    id
    Type
    string
    Required
    Required
    Description

    A unique ID of an existing verification.

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

Request

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

POST/v1/verifications

Create a Verification

A Verification describes the intent to verify a participant.

Optional attributes

  • Name
    id
    Type
    string
    Description

    A unique ID of an existing participant that needs to be verified.

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

  • Name
    type
    Type
    enum
    Description

    unknown individual business third_party organisation

    The type of participant to verify. This helps inform the verification process in the Verify UI.

  • Name
    email
    Type
    string
    Description

    The email of the participant to verify.

  • Name
    name
    Type
    string
    Description

    The name of the participant to verify.

  • Name
    address
    Type
    object
    Description

    An object describing the address of the participant to verify.

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

  • Name
    bank_account
    Type
    object
    Description

    A bank account describing the address of the participant to verify.

    • 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
      string
      Description

      The CNAPS of the bank account (CN only).

    • Name
      ifsc
      Type
      string
      Description

      The IFSC of the bank account (IN only).

    • Name
      sort_code
      Type
      string
      Description

      The Sort Code of the bank account (UK only).

    • Name
      bank_name
      Type
      string
      Description

      The Bank Name of the bank account.

    • Name
      bank_address
      Type
      string
      Description

      The Bank Address of the bank account.

    • Name
      identification
      Type
      string
      Description

      The identification type of the bank account (MX only).

    A bank account describing the address of the participant to verify.

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

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