AM/FA/Inv - Enterprise Organization Update Metadata

Details

/external/v1/org/{orgId}/data

Synopsis

Enterprise Organization Update Metadata

put

This route is used for an organization (or a channel administrator on its behalf) to update its data on the blockchain. This triggers an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints. This endpoint can be called by applications with access to scope "manageOrgs".

Required scopes

This endpoint requires the following scopes:

• : manageOrgs

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

orgIdanyRequired

The unique identifier of the organization on the blockchain

Example: US9QIMA

Body

application/json

namestring · max: 200Required

The name of the organization.

Example: Bank Name

integrationApiAddressstringRequired

The url to the integration rest api.

Example: https://integration-api.atorg.com

transactionDataall ofRequired

This property contains the transactional data information, i.e. signer information and signature mechanism

Example: {"signer":{"email":"[email protected]","name":"John Doe"}}

orgACLstring[]Optional

The orgId(s) of the organizations that this org does business with.

Example: ["US9QIMA","US9QIMB"]

Responses

200

Successfully triggered the process to update org metadata on the ledger The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

400

The following error codes can be returned: - GN0002 - OG0021 - OG0022 - OG0018 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 - AU0003 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - OG0013 - OG0002 - OG0020 - OG0026 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/org/{orgId}/data

HTTPcURLJavaScriptPython

PUT /external/v1/org/{orgId}/data HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "extraData": {
    "externalId": "123456789",
    "some": "Custom Property"
  },
  "name": "Bank Name",
  "outboundAddressList": [
    {
      "ip": "127.0.0.1",
      "address": "outbound.atorg.com"
    }
  ],
  "integrationApiAddress": "https://integration-api.atorg.com",
  "transactionData": {
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "orgACL": [
    "US9QIMA",
    "US9QIMB"
  ]
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}