SubscriberDetails API documentation version 1.0.0

https://api-int.syniverse.com/user-identity/v1/

About User Identity

The purpose of this specification is to describe the Syniverse User Identity Services capabilities, core concepts, and API set. The User Identity is intended to be a REST API-based advanced services to support various use cases of Enterprise Customers.

AccountInfo

Resource attributes:

  • accountStatus (string): Status of the Subscriber Account

  • accountSubType (string): Like postpaid

  • isPrimarySubscriber (boolean): If Subscriber is primary account holder OR additional member

//subscribers/{subscriber_id}/account-info get post delete put

Returns the account details of the specified subscriber.

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

Query Parameters

  • accountStatus: (string)

    Filter

  • accountSubType: (string)

    Filter

  • isPrimarySubscriber: (boolean)

    Filter

  • applicationId: (string)

    Parameter

  • supplierId: (string)

    Parameter

  • consentGrant: (string)

    Parameter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AccountInfo",
  "type": "object",
  "properties": {
    "accountStatus": {
      "type": "string"
    },
    "accountSubType": {
      "type": "string"
    },
    "isPrimarySubscriber": {
      "type": "boolean"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

n/a

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

Query Parameters

  • applicationId: (string)

    Parameter

  • supplierId: (string)

    Parameter

  • consentGrant: (string)

    Parameter

Body

Type: application/json

Form Parameters
  • accountStatus: (string)
  • accountSubType: (string)
  • isPrimarySubscriber: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

n/a

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

n/a

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters
  • accountStatus: (string)
  • accountSubType: (string)
  • isPrimarySubscriber: (boolean)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

NameAddress

Resource attributes:

  • lastName (string): The last name of the subscriber

  • firstName (string): The first name of the subscriber

  • middleName (string): The middle name of the subscriber

  • namePrefix (string): The name prefix of the subscriber

  • nameSuffix (string): The name suffix of the subscriber

  • addressType (string): The type of the address. Valid values are 'HOME', 'BUSINESS'.

  • addressLine1 (string): The first line of the provided address

  • addressLine2 (string): The second line of the provided address

  • addressSuite (string): The suite associated with the address

  • city (string): The city for the provided address

  • state (string): The state for the provided address

  • country (string): The country for the provided address

  • postalCode (string): The postalCode for the provided address

  • postalCodeExtension (string): The postalCodeExtension for the provided address

  • additionalFields (Array): (string): The additionalFields for the provided address

//subscribers/{subscriber_id}/name-address get post delete put

Returns the name and address details of the specified subscriber.

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

Query Parameters

  • applicationId: (string)

    Parameter

  • supplierId: (string)

    Parameter

  • grantId: (string)

    Parameter

  • providerId: (string)

    Parameter

HTTP status code 200

Successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "NameAddress",
  "type": "object",
  "properties": {
    "lastName": {
      "type": "string"
    },
    "firstName": {
      "type": "string"
    },
    "middleName": {
      "type": "string"
    },
    "namePrefix": {
      "type": "string"
    },
    "nameSuffix": {
      "type": "string"
    },
    "addressType": {
      "type": "string"
    },
    "addressLine1": {
      "type": "string"
    },
    "addressLine2": {
      "type": "string"
    },
    "addressSuite": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "postalCode": {
      "type": "string"
    },
    "postalCodeExtension": {
      "type": "string"
    },
    "additionalFields": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

n/a

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

Query Parameters

  • applicationId: (string)

    Parameter

  • supplierId: (string)

    Parameter

  • grantId: (string)

    Parameter

  • providerId: (string)

    Parameter

Body

Type: application/json

Form Parameters
  • lastName: (string)
  • firstName: (string)
  • middleName: (string)
  • namePrefix: (string)
  • nameSuffix: (string)
  • addressType: (string)
  • addressLine1: (string)
  • addressLine2: (string)
  • addressSuite: (string)
  • city: (string)
  • state: (string)
  • country: (string)
  • postalCode: (string)
  • postalCodeExtension: (string)
  • additionalFields: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

n/a

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

n/a

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters
  • lastName: (string)
  • firstName: (string)
  • middleName: (string)
  • namePrefix: (string)
  • nameSuffix: (string)
  • addressType: (string)
  • addressLine1: (string)
  • addressLine2: (string)
  • addressSuite: (string)
  • city: (string)
  • state: (string)
  • country: (string)
  • postalCode: (string)
  • postalCodeExtension: (string)
  • additionalFields: (string)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

Score

Resource attributes:

  • lastName (string): The last name of the subscriber

  • firstName (string): The first name of the subscriber

  • addressLine1 (string): The first line of the provided address

  • addressLine2 (string): The second line of the provided address

  • city (string): The city for the provided address

  • state (string): The state for the provided address

  • postalCode (string): The postalCode for the provided address

//subscribers/{subscriber_id}/score post delete put

Returns zero or 100 for each field supplied that is matched against carrier given data

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

Query Parameters

  • applicationId: (string)

    Parameter

  • supplierId: (string)

    Parameter

  • consentGrant: (string)

    Parameter

  • type: (string)

    Parameter

  • providerId: (string)

    Parameter

Body

Type: application/json

Form Parameters
  • lastName: (string)
  • firstName: (string)
  • addressLine1: (string)
  • addressLine2: (string)
  • city: (string)
  • state: (string)
  • postalCode: (string)

HTTP status code 200

successful operation

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Create Resource Response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  }
}

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field
  • UID0019 - Invalid Address - Address returned by Provider is not valid
  • UID0020 - Invalid Address - Address passed in the request is not valid

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

n/a

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field
  • UID0019 - Invalid Address - Address returned by Provider is not valid
  • UID0020 - Invalid Address - Address passed in the request is not valid

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.

n/a

URI Parameters

  • subscriber_id: required (string)

    This is the unique identifier of the subscriber resource.

Body

Type: application/x-www-form-urlencoded

Form Parameters
  • lastName: (string)
  • firstName: (string)
  • addressLine1: (string)
  • addressLine2: (string)
  • city: (string)
  • state: (string)
  • postalCode: (string)

HTTP status code 200

successful operation

Body

Type: application/json

HTTP status code 400

Bad Request. The request could not be understood by the server.

Possible Error Codes:

  • UID0011 - Syntactically invalid field. - Phone Number/Provider is Syntactically invalid field
  • UID0019 - Invalid Address - Address returned by Provider is not valid
  • UID0020 - Invalid Address - Address passed in the request is not valid

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 401

Unauthorized. The request requires user authentication.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 402

Payment Required.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 403

Forbidden. The user does not have permission to access the specified resource.

Possible Error Codes:

  • UID0003 - ApplicationId is missing - Application Identifier that Identifies the Use Case is missing
  • UID0004 - Supplier Id is missing - Supplier Id is required to ensure the subscriber is not moved
  • UID0005 - GrantId is missing - GrantId is required to process the request
  • UID0013 - Invalid Application - Consent identity verification invalid (User supplied Application ID does not belong to the Consented Use Case ).
  • UID0009 - Invalid Supplier - Supplier Id passed is not valid for given subscriberid
  • UID0008 - Grant Found but expired or exceeded the usage count - Grant was used after allowed time period OR used more than allowed usage count
  • UID0010 - Grant Not Valid for The Subscriber ID OR Use Case - Grant not Valid for the combination of Supplier Id, ProviderId and Use Case. Check valid Supplier ID, ProviderId and Use Case was used
  • UID0021 - ProviderId is missing - ProviderId is required to process the request

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 404

"Not Found. The server has not found anything matching the Request-URI."

HTTP status code 409

Conflict. The request could not be completed due to a conflict with the current state of the target resource.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 412

Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 429

Too Many Requests. The user has sent too many requests in a given amount of time.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 500

Server Error. An error has been encountered while processing this request.

Possible Error Codes:

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response",
  "type": "object",
  "properties": {
    "error_code": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  }
}

HTTP status code 503

Server Unavailable.