Get account creation process

GET

/v2/organizations/:organizationId/assetGroup/:assetGroupId/subAccountCreated/:assetGroupWorkId

GET

/Management/v2/organizations/:organizationId/assetGroup/:assetGroupId/subAccountCreated/:assetGroupWorkId

curl https://api-d.docusign.net/Management/v2/organizations/organizationId/assetGroup/assetGroupId/subAccountCreated/assetGroupWorkId

200Retrieved

{
  "assetGroupId": "string",
  "assetGroupWorkId": "string",
  "assetGroupWorkType": "Undefined",
  "attempts": 1,
  "createAccountProcessingFailureDetails": {
    "error": "string",
    "errorDescription": "string",
    "isSystemError": true
  },
  "createdByEmail": "string",
  "createdByName": "string",
  "createdDate": "2024-01-15T09:30:00Z",
  "message": "string",
  "orderId": "string",
  "status": "Undefined",
  "subscriptionDetails": {
    "id": "string",
    "modules": [
      {
        "moduleId": "string",
        "moduleName": "string"
      }
    ],
    "planId": "string",
    "planName": "string"
  },
  "targetAccount": {
    "admin": {
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "locale": "None"
    },
    "countryCode": "string",
    "id": "string",
    "name": "string",
    "region": "string",
    "site": "string"
  }
}

Gets information about an account creation process by the assetGroupId.

To call this endpoint:

You must be an administrator for the specified organization

Required scopes: organization_sub_account_read

Path parameters

organizationIdstringRequiredformat: "uuid"

The organization's GUID.

assetGroupIdstringRequiredformat: "uuid"

The ID of the asset group.

assetGroupWorkIdstringRequiredformat: "uuid"

The ID of the asset group account clone request.

Query parameters

include_detailsbooleanOptional

When true, include details for the asset group account clone.

Response

assetGroupIdstringOptionalformat: "uuid"

The ID of the asset group to which the accounts belong.

assetGroupWorkIdstringOptionalformat: "uuid"

The ID of the job that is created by the request.

assetGroupWorkTypeenumOptional

The type of asset group work. This property is read-only.

attemptsintegerOptional

The number of times the job has been attempted.

createAccountProcessingFailureDetailsobjectOptional

createdByEmailstringOptional

The email of the creator of the account clone work.

createdByNamestringOptional

The name of the creator of the account clone work.

createdDatedatetimeOptional

The date the account clone work is created.

messagestringOptional

The message associated with the account clone work.

orderIdstringOptionalformat: "uuid"

The order ID created by the clone work.

statusenumOptional

The status of the account creation request.

subscriptionDetailsobjectOptional

targetAccountobjectOptional