> ## Documentation Index
> Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get action requirement details for a sub number order

> Returns the input fields an action requirement needs and the current requirement action for a sub number order. Action requirements are fulfilled by an external step rather than by uploading documents. Australia mobile ID verification is currently the only action requirement. Once a verification link has been generated, it is returned in `requirement_action.value`.



## OpenAPI

````yaml /openapi/source/external/numbers/numbers.json get /external_requirements/{regulatory_requirement_id}/sub_number_orders/{sub_number_order_id}
openapi: 3.1.0
info:
  x-latency-category: responsive
  x-endpoint-cost: light
  version: 2.0.0
  title: Telnyx API
  description: SIP trunking, SMS, MMS, Call Control and Telephony Data Services.
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
    description: Version 2.0.0 of the Telnyx API
security:
  - bearerAuth: []
tags:
  - name: Phone Number Search
    description: Number search
  - name: Phone Number Reservations
    description: Number reservations
  - name: Phone Number Orders
    description: Number orders
  - name: Inexplicit Number Orders
    description: >-
      Inexplicit number orders for bulk purchasing without specifying exact
      numbers
  - name: Phone Number Order Documents
    description: Number order documents
  - name: Phone Number Configurations
    description: Configure your phone numbers
  - name: Bulk Phone Number Operations
    description: Background jobs performed over a batch of phone numbers
  - name: Inventory Level
    description: Inventory Level
  - name: Phone Number Blocks Background Jobs
    description: Background jobs performed over a phone-numbers block's phone numbers
  - name: Regulatory Requirements
    description: Regulatory Requirements
  - name: Requirement Groups
    description: Requirement Groups
  - name: Country Coverage
    description: Country Coverage
  - name: Callbacks
    description: Callbacks
paths:
  /external_requirements/{regulatory_requirement_id}/sub_number_orders/{sub_number_order_id}:
    get:
      tags:
        - Requirement Groups
      summary: Get action requirement details for a sub number order
      description: >-
        Returns the input fields an action requirement needs and the current
        requirement action for a sub number order. Action requirements are
        fulfilled by an external step rather than by uploading documents.
        Australia mobile ID verification is currently the only action
        requirement. Once a verification link has been generated, it is returned
        in `requirement_action.value`.
      operationId: getExternalRequirement
      parameters:
        - name: regulatory_requirement_id
          in: path
          required: true
          description: >-
            The ID of the regulatory (action) requirement. For Australia mobile
            ID verification this is `b7c72fb8-fa08-4529-aaf6-b9117d3f3698`.
          schema:
            type: string
            format: uuid
        - name: sub_number_order_id
          in: path
          required: true
          description: The ID of the sub number order the requirement belongs to.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Action requirement details retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      regulatory_requirement_id:
                        type: string
                        format: uuid
                      fields_required:
                        type: array
                        description: >-
                          The fields the end user must provide to fulfill this
                          requirement.
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              description: >-
                                The field name to send inside the `requirement`
                                object on the POST.
                              example: first_name
                            type:
                              type: string
                              example: string
                            description:
                              type: string
                              example: First Name
                            value:
                              type:
                                - string
                                - 'null'
                              description: >-
                                The value already stored for this field, or null
                                if not yet provided.
                      requirement_action:
                        type: object
                        properties:
                          type:
                            type: string
                            description: The type of action the end user must complete.
                          value:
                            type:
                              - string
                              - 'null'
                            description: >-
                              The action value. For ID verification this is the
                              verification link URL, or null until it has been
                              generated.
              example:
                data:
                  regulatory_requirement_id: a5b8f1d2-3c4e-4f6a-8b9c-0d1e2f3a4b5c
                  fields_required:
                    - name: first_name
                      type: string
                      description: First Name
                      value: null
                    - name: last_name
                      type: string
                      description: Last Name
                      value: null
                  requirement_action:
                    type: id_verification
                    value: null
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '500':
          $ref: '#/components/responses/GenericErrorResponse'
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Telnyx from 'telnyx';


            const client = new Telnyx({
              apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
            });


            const response = await
            client.externalRequirements.subNumberOrders.retrieve('regulatory_requirement_id',
            'sub_number_order_id');


            console.log(response.data);
        - lang: Python
          source: |
            import os
            from telnyx import Telnyx

            client = Telnyx(
                api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
            )
            response = client.external_requirements.sub_number_orders.retrieve(
                "regulatory_requirement_id",
                "sub_number_order_id",
            )
            print(response.data)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tsubNumberOrder, err := client.ExternalRequirements.SubNumberOrders.Get(\n\t\tcontext.TODO(),\n\t\t\"regulatory_requirement_id\",\n\t\t\"sub_number_order_id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", subNumberOrder.Data)\n}\n"
        - lang: Java
          source: |-
            package com.telnyx.sdk.example;

            import com.telnyx.sdk.client.TelnyxClient;
            import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    TelnyxClient client = TelnyxOkHttpClient.fromEnv();

                    var response = client.externalRequirements().subNumberOrders().retrieve("regulatory_requirement_id", "sub_number_order_id");
                }
            }
        - lang: Ruby
          source: >-
            require "telnyx"


            telnyx = Telnyx::Client.new(api_key: "My API Key")


            response =
            telnyx.external_requirements.sub_number_orders.retrieve("regulatory_requirement_id",
            "sub_number_order_id")


            puts(response)
        - lang: PHP
          source: >-
            <?php


            require_once dirname(__DIR__) . '/vendor/autoload.php';


            use Telnyx\Client;

            use Telnyx\Core\Exceptions\APIException;


            $client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API
            Key');


            try {
              $response = $client->externalRequirements->subNumberOrders->retrieve(
                'regulatory_requirement_id',
                'sub_number_order_id',
              );

              var_dump($response);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: CLI
          source: |-
            telnyx external-requirements:sub-number-orders retrieve \
              --api-key 'My API Key' \
              --regulatory-requirement-id regulatory_requirement_id \
              --sub-number-order-id sub_number_order_id
components:
  responses:
    UnauthorizedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          examples:
            Authentication Failed:
              value:
                errors:
                  - code: '10009'
                    title: Authentication failed
                    detail: Could not understand the provided credentials.
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10009
    NotFoundResponse:
      description: The requested resource doesn't exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    GenericErrorResponse:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
  schemas:
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    Error:
      properties:
        code:
          type: string
          example: '10007'
        title:
          type: string
          example: Unexpected error
        detail:
          type: string
          example: An unexpected error occured.
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              example: /base
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties:
            url:
              type: string
              description: URL with additional information on the error.
              example: https://developers.telnyx.com/docs/overview/errors/10015
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````