# Create Contact

Create a new address book contact in an organization.

Endpoint: POST /api/v1/addressbook/contacts
Version: 0.2.0
Security: bearerAuth

## Header parameters:

  - `x-signature` (string)
    Signature of the body. Base64 encoded string. If the request is made programatically by an API user, signing of the request is required and is intended to protect you from malicious backends. `x_signature` is valid for 120 seconds.

  - `x-timestamp` (integer)
    Timestamp of the signature. Integer. Specify an Epoch date. If the request is made programatically by an API user, the timestamp of the request is required and is intended to protect you from replay attacks.

## Request fields (application/json):

  - `name` (string, required)
    The name of the contact.

  - `group_ids` (array)
    The unique identifiers of the address groups.

  - `type` (string, required)
    The type of the chain.

  - `address` (string, required)
    The address on the Aptos chain.
    Example: 0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a

  - `chains` (array)
    The chains the contact belongs to. If not provided, the contact will be associated with all chains.

  - `assets_identifiers` (array)
    The assets identifiers of the contact.

  - `assets_identifiers.type` (string, required)
    Aptos asset identifier type.

  - `assets_identifiers.details` (any, required)

  - `assets_identifiers.details.type` (string, required)
    Aptos asset identifier type.

  - `assets_identifiers.details.type` (string, required)
    Legacy coin asset identifier type.

  - `assets_identifiers.details.coin_type` (object, required)
    Coin type represents a blockchain legacy coin type.

  - `assets_identifiers.details.coin_type.coin_type_str` (string, required)
    Coin type string representation.

  - `assets_identifiers.details.type` (string, required)
    New coin asset identifier type.

  - `assets_identifiers.details.new_coin_type` (object, required)
    New coin type represents a blockchain new coin type.

  - `assets_identifiers.details.new_coin_type.metadata_address` (string, required)
    New coin's metadata address.

  - `address` (string, required)
    The address on the arch chain.
    Example: 4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA

  - `address` (string, required)
    The party id on the Canton chain.
    Example: 45b72ac2a9742204e6e5f521781b0648::122028536bd166988ebbb422c7f483bb32d4134127e8c171c9666ce9b518e1dd27cf

  - `memo` (string)
    Memo is an additional address feature used for identifying a recipient.

  - `address` (string, required)
    The address on the cosmos chain in bech32 representation.

  - `chain` (string, required)
    Enum: "cosmos_agoric-3", "cosmos_akashnet-2", "cosmos_archway-1", "cosmos_axelar-dojo-1", "cosmos_bbn-1", "cosmos_celestia", "cosmos_cosmoshub-4", "cosmos_dydx-mainnet-1", "cosmos_dydx-testnet-4", "cosmos_dymension_1100-1", "cosmos_injective-1", "cosmos_neutron-1", "cosmos_nillion-1", "cosmos_noble-1", "cosmos_osmosis-1", "cosmos_provider", "cosmos_ssc-1", "cosmos_pacific-1", "cosmos_stride-1", "cosmos_thorchain-1", "cosmos_mantra-1"

  - `address` (string, required)
    The address of the contact.
    Example: 0x71C7656EC7ab88b098defB751B7401B5f6d8976F

  - `address` (string, required)
    The classic address on the Ripple chain.
    Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh

  - `tag` (string)
    The XRP Ledger destination tag, a numeric value used for identifying a recipient.

  - `address` (string, required)
    The address on the solana chain.
    Example: 4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA

  - `address` (string, required)
    The address on the Stacks chain.
    Example: SP3J4NWQXC312DK0GXVRZKSRFBZG8S5FG1D2160E9

  - `address` (string, required)
    The address on the Starknet chain.
    Example: 0x0448f450e64B50dDF49e9F95C5b63a15cD21E21a39cA2D45628d9E5B27e5e1D8

  - `address` (string, required)
    The address on the Stellar chain.
    Example: GBRPYHIL2CI3FNQ4BXLFMNDLFJHO7W3B6FSHLTAVM2A4P45SHO4ZB7I2

  - `address` (string, required)
    The address on the sui chain.
    Example: 0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a

  - `address` (string, required)
    The address TON contract in any format.

  - `comment` (string)
    Comment is an additional address feature used for identifying a recipient.

  - `address` (string, required)
    The address on the TRON chain.
    Example: TJCnKsPa7y5okkXvQAidZBzqx3QyQ6sxMW

  - `address` (string, required)
    The address on the utxo chain.
    Example: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq

## Response 200 fields (application/json):

  - `id` (string, required)
    The unique identifier of the object in the Fordefi platform.

  - `created_at` (string, required)
    The date and time when the object was created.

  - `modified_at` (string, required)
    The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

  - `name` (string, required)
    The name of the contact.

  - `modified_by` (any, required)
    Represents a reference to a user in the Fordefi platform

  - `modified_by.id` (string, required)
    The unique identifier of the user in the Fordefi platform.

  - `modified_by.user_type` (string, required)
    The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.

  - `modified_by.name` (string)
    The name of the user.
    Example: John Doe

  - `modified_by.email` (string, required)
    The email of the user.

  - `modified_by.state` (string, required)
    Enum: "active", "onboarding_pending_code_generation", "onboarding_pending_activation", "reset_device_pending_code_generation", "reset_device_pending_activation", "pending_approval", "deleted"

  - `modified_by.role` (string, required)
    Enum: "admin", "trader", "viewer"

  - `modified_by.user_type` (string, required)
    The type of the user.

  - `modified_by.state` (string, required)
    The state of the user.
    Enum: "active", "deleted"

  - `modified_by.external_id` (string, required)
    External id of the user.
    Example: user|1234

  - `modified_by.name` (string, required)
    The name is Fordefi CARE

  - `state` (string, required)
    Enum: "pending", "active", "deleted"

  - `groups` (array, required)
    List of contact's groups.

  - `groups.id` (string, required)
    The unique identifier of the address book group in the Fordefi platform.

  - `groups.name` (string, required)
    The name of the group.

  - `groups.contacts_count` (integer, required)
    The number of contacts in the group.

  - `pending_changes` (object)
    Represents pending changes for a contact in the Fordefi platform

  - `pending_changes.change_request_id` (string)
    The change request ID of the contact.

  - `pending_changes.change_request_reason` (string, required)
    Enum: "creation", "modification"

  - `pending_changes.batch_size` (integer, required)
    The number of contacts in the change request.

  - `asset_infos` (array, required)
    A list of asset infos for the contact. Can be used to enforce trading of specific assets intransfers to this address

  - `asset_infos.id` (string, required)
    The asset ID.

  - `asset_infos.asset_identifier` (any, required)

  - `asset_infos.asset_identifier.type` (string, required)
    Aptos asset identifier type.

  - `asset_infos.asset_identifier.details` (any, required)

  - `asset_infos.asset_identifier.details.type` (string, required)
    Aptos asset identifier type.

  - `asset_infos.asset_identifier.details.chain` (string, required)
    Enum: "aptos_mainnet", "aptos_testnet", "aptos_movement_mainnet", "aptos_movement_testnet"

  - `asset_infos.asset_identifier.details.type` (string, required)
    Legacy coin asset identifier type.

  - `asset_infos.asset_identifier.details.coin_type` (object, required)
    Coin type represents a blockchain legacy coin type.

  - `asset_infos.asset_identifier.details.coin_type.coin_type_str` (string, required)
    Coin type string representation.

  - `asset_infos.asset_identifier.details.type` (string, required)
    New coin asset identifier type.

  - `asset_infos.asset_identifier.details.new_coin_type` (object, required)
    New coin type represents a blockchain new coin type.

  - `asset_infos.asset_identifier.details.new_coin_type.metadata_address` (string, required)
    New coin's metadata address.

  - `asset_infos.asset_identifier.chain` (object, required)

  - `asset_infos.asset_identifier.chain.chain_type` (string, required)
    The type of the chain.

  - `asset_infos.asset_identifier.chain.name` (string, required)
    The full blockchain name.

  - `asset_infos.asset_identifier.chain.native_currency_symbol` (string, required)
    The native currency symbol.
    Example: ETH

  - `asset_infos.asset_identifier.chain.native_currency_name` (string, required)
    The native currency name.
    Example: Ether

  - `asset_infos.asset_identifier.chain.blockchain_explorer` (object)
    A blockchain explorer entry point.

  - `asset_infos.asset_identifier.chain.blockchain_explorer.transaction_url` (string, required)
    Example: https://etherscan.io/tx/

  - `asset_infos.asset_identifier.chain.blockchain_explorer.address_url` (string, required)
    Example: https://etherscan.io/address/

  - `asset_infos.asset_identifier.chain.blockchain_explorer.root_url` (string, required)
    Example: https://etherscan.io/

  - `asset_infos.asset_identifier.chain.blockchain_explorer.transaction_format_url` (string)
    Example: https://etherscan.io/tx/%s

  - `asset_infos.asset_identifier.chain.blockchain_explorer.address_format_url` (string)
    Example: https://etherscan.io/address/%s

  - `asset_infos.asset_identifier.chain.blockchain_explorer.asset_format_url` (string)
    Example: https://etherscan.io/address/%s

  - `asset_infos.asset_identifier.chain.logo_url` (string, required)
    The logo URL of the chain.

  - `asset_infos.asset_identifier.chain.is_testnet` (boolean, required)
    Whether the chain is on a testnet.

  - `asset_infos.asset_identifier.chain.is_enabled` (boolean, required)
    Whether the chain is enabled.

  - `asset_infos.asset_identifier.type` (string, required)
    Arch asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Canton asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Cosmos asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Asset identifier type.

  - `asset_infos.asset_identifier.exchange_type` (string, required)
    Enum: "binance", "bybit", "coinbase_international", "coinbase_us", "okx", "kraken", "paxos"

  - `asset_infos.asset_identifier.asset_symbol` (string, required)
    The symbol of the asset on the exchange.

  - `asset_infos.asset_identifier.type` (string, required)
    Ripple asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Solana asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Stacks asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Stellar asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Starknet asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Sui asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    TON asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    TRON asset identifier type.

  - `asset_infos.asset_identifier.type` (string, required)
    Utxo asset identifier type.

  - `asset_infos.name` (string, required)
    The name of the asset.

  - `asset_infos.symbol` (string, required)
    The symbol (ticker) of the asset.

  - `asset_infos.decimals` (integer, required)

  - `asset_infos.verified` (boolean, required)
    `True` if this asset is verified by Fordefi, `False` otherwise.

  - `asset_infos.metadata_uri` (string)
    The URI of the asset metadata.

  - `asset_infos.is_spam` (boolean, required)
    `True` if this asset is spam, `False` otherwise.

  - `asset_infos.logo_url` (string)
    The URL of the asset logo.

  - `asset_infos.explorer_url` (string)
    The URL of a blockchain explorer that provides real-time information about the asset.

  - `asset_infos.issuer_name` (string)
    Best-effort display name of the issuer

  - `chain_type` (string, required)
    The type of the chain.

  - `address` (string, required)
    The address on the aptos chain.
    Example: 0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a

  - `chains` (array, required)
    The chains the contact belongs to. If empty, the contact is associated with all chains.

  - `address` (string, required)
    The address on the Arch chain.
    Example: 4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA

  - `address` (string, required)
    The party id on the Canton chain.
    Example: 45b72ac2a9742204e6e5f521781b0648::122028536bd166988ebbb422c7f483bb32d4134127e8c171c9666ce9b518e1dd27cf

  - `memo` (string)
    Memo is an additional address feature used for identifying a recipient.

  - `address` (string, required)
    The address on the cosmos chain.

  - `address` (string, required)
    TThe address of the contact.
    Example: 0x71C7656EC7ab88b098defB751B7401B5f6d8976F

  - `address` (string, required)
    The classic address on the Ripple chain.
    Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh

  - `tag` (string)
    The XRP Ledger destination tag, a numeric value used for identifying a recipient.

  - `address` (string, required)
    The address on the solana chain.
    Example: 4fYNw3dojWmQ4dXtSGE9epjRGy9pFSx62YypT7avPYvA

  - `address` (string, required)
    The address on the stacks chain.
    Example: SP3J4NWQXC312DK0GXVRZKSRFBZG8S5FG1D2160E9

  - `address` (string, required)
    The address on the starknet chain.
    Example: 0x0448f450e64B50dDF49e9F95C5b63a15cD21E21a39cA2D45628d9E5B27e5e1D8

  - `address` (string, required)
    The address on the Stellar chain.
    Example: GBRPYHIL2CI3FNQ4BXLFMNDLFJHO7W3B6FSHLTAVM2A4P45SHO4ZB7I2

  - `address` (string, required)
    The address on the sui chain.
    Example: 0x3300c18e7b931bdfc73dccf3e2d043ad1c9d120c777fff5aeeb9956224e5247a

  - `address` (string, required)
    The address on the TON chain.

  - `comment` (string)
    Comment is an additional address feature used for identifying a recipient.

  - `address` (string, required)
    The address on the TRON chain.
    Example: TJCnKsPa7y5okkXvQAidZBzqx3QyQ6sxMW

  - `address` (string, required)
    The address on the utxo chain.
    Example: bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq

## Response 400 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

  - `system_error_code` (string)
    An additional system error code in Fordefi.

## Response 401 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 403 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 408 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 422 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (array, required)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 500 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

