NAV
javascript python java

Introdução

O Open Insurance, ou Sistema de Seguros Aberto, é a possibilidade de consumidores de produtos e serviços de seguros, previdência complementar aberta e capitalização permitirem o compartilhamento de suas informações entre diferentes sociedades autorizadas/credenciadas pela Susep, de forma segura, ágil, precisa e conveniente.

Para entregar esses benefícios ao consumidor, o Open Insurance operacionaliza e padroniza o compartilhamento de dados e serviços por meio de abertura e integração de sistemas, com privacidade e segurança.

Notificações

Informes

Confira as últimas atualizações da Estrutura de Governança do Open Insurance Brasil.

Open Insurance Comunica #8/2022 – 16/02/2022 – Formulário e Orientações para Cadastro de APIs
Open Insurance Comunica #14/2022 - 23/02/2022 – Publicação da Versão V1.0.3 de Swaggers
Open Insurance Comunica #16/2022 – 24/02/2022 – Liberação do Motor de Conformidade - V1.0.3 de Swaggers
Open Insurance Comunica #17/2022 – 24/02/2022 – Esclarecimentos Sobre Produtos com Coberturas em APIs Distintas
Open Insurance Comunica #18/2022 - 24/02/2022 – Direcionamento de Erros Conhecidos para Homologação de APIs
Open Insurance Comunica #19/2022 – 25/02/2022 – Direcionamento para Execução dos Testes de Conformidade da API de Discovery
Open Insurance Comunica #20/2022 - 04/03/2022 – Recomendação Sobre "erro forbidden" na Publicação de Endpoints
Open Insurance Comunica #22/2022 - 09/03/2022 – Publicação das APIs da Etapa 2 da Fase 1
Open Insurance Comunica #30/2022 – 30/03/2022 - Liberação do Motor de Conformidade para homologação de APIs 1.2 Open Insurance Comunica #34/2022 – 08/04/2022 - Disponibilização do Motor de Conformidade para a Etapa II Open Insurance Comunica #37/2022 – 29/03/2022 - Homologação Automática Diretório de Participantes

Manuais para participantes

Passo a passo para cadastro de Endpoint’s - dados públicos Fase 1
Passo a passo de cadastro no diretório
Passo a passo Cadastro Contatos Técnicos Diretório
Passo a passo testes de confomidade APIs
Orientação de homologação de API
Recomendações Cadastro APIs Diretório
Passo a passo de cadastro no diretório (Ambiente de SandBox)
Criando uma Declaração de Software
Gerando o Certificado BRCAC
Gerando o Certificado BRSEAL
Obtendo um token para acesso as APIs do Diretório Processo de certificação

Calendário

Este anexo tem como objetivo detalhar quando a versão das APIs do Open Insurance é alterada. Ele poderá ser acessado clicando aqui.

Este anexo tem como objetivo detalhar quando a versão das APIs do Open Insurance é alterada, conforme a classificação da modificação.Ele poderá ser acessado clicando aqui.

Major*: Versão gerada para mudanças de legislação e atualização de documentações oficiais que só poderão ser lançadas com a anuência da SUSEP, por exemplo, v1.0.0 e v2.0.0;

Minor: Versão gerada quando forem realizadas atualizações que descompatibilizam o mercado, mas que não se tratam de versões major, por exemplo, v1.1.0 e v1.2.0;

Patch: Versão gerada quando há correção de bug ou alteração da documentação que não impacta ou descompatibiliza a API (v1.1.1)

OBS: A instituição deve obrigatoriamente refazer a certificação das APIs no Diretório de Participantes conforme release de uma versão major, minor ou patch.

Alteração Versionamento
Adição de obrigatoriedade de campo minor
Alteração de pattern que impacta a validação
Retirada de campo minor
Adição de campo minor
Ajuste na grafia do campo minor
Alteraçao do tipo do campo minor
Diminuição de número de caracteres minor
Atualizações de REGEX para início de validação de campos antes não validados minor
Atualização de patterns que não impactam a validação patch
Retirada de obrigatoriedade de campo patch
Aumento no número de caracteres patch
Adição de enum patch
Ajuste na descrição do campo patch
Alteração nos exemplos do campo patch
Atualizações de REGEX que não impactam a validação patch
Alteração de pattern que não impacta a validação patch
Retirada de campo não obrigatório patch
Adição de campo não obrigatório patch
Retirada da obrigatoriedade de um Campo patch

Segurança

Introdução - Segurança

Esta seção tem como finalidade auxiliar na auto avaliação aos cumprimentos dos requisitos de segurança da informação relacionados a autorização e autenticação de APIs e End-Users, emissão de certificados digitais e requisitos para o onboarding no Diretório de participantes para as Instituições participantes do Open Insurance.

As instituições participantes do Open Insurance possuem a obrigação de acompanhar a edição e a revogação de eventuais normas com impacto no tema de forma a estar permanentemente em dia com as determinações legais. Compõem, de forma não exaustiva, o rol de atos normativos cuja observância é essencial pelas instituições participantes do Open Insurance:

Normativa
Resolução CNSP nº 415, de 2021
Circular Susep nº 635, de 2021
Circular Susep nº 638, de 2021
Lei Geral de Proteção de Dados (LGPD – Lei nº 13.709, de 2018)

Estas especificações baseiam-se, referenciam, e complementam, quando aplicável, os seguintes documentos:

Referência
BCP 195/RFC 7525
Owasp API Top 10
Sans Top 25 Software Errors
CWE Top 25 Software Weaknesses
NIST 800-88
DOD 5220.22-M
ICP Brasil - Manual de Condutas Técnicas 7 - Volume I

Além desse guia, foi elaborado um checklist para auxiliar os participantes do Open Insurance a alcançar um nível adequado de Segurança da Informação, esse checklist pode ser baixado em formato Excel a seguir:

Download Autoavaliação dos requisitos de SI - 1.0.xlsx

Visão geral

As APIs de Open Insurance estão dividas em dois escopos:

Segue, a continuação, um overview das camadas de segurança básicas para atender os contextos Open-data:

Camada Descrição Explicação
Física Firewall Equipamentos e produtos como filtros, proxys e firewalls direcionados ao controle e segurança da rede física.
Transporte HTTP - TLS 1.2 Protocolo de criptografia que fornece segurança na comunicação sobre a rede física.
Gestão API Gateway / Manager Gateway e Manager para gerenciar a publicação da API com controles de throttling, quotas e outros.

Manual de Segurança

A documentação que detalha os controles técnicos de segurança que serão implementados na arquitetura do Open Insurance junto do conjunto padronizado de regras e requisitos para formação do framework de confiança para acesso de recursos protegidos pode ser acessado aqui

Guia do usuário: Instituição Transmissora e Receptora

Área em construção

Diretório de Participantes

Participantes Open Insurance Brasil

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Informações sobre os servidores de autorização dos participantes do Open Insurance Brasil que estão registrados no Diretório.

Base URLs:

License: MIT

A especificação do arquivo de participantes pode ser acessada aqui.

Organisations

Recupera informações técnicas sobre Participantes registrados no diretório, essas informações permitem identificar e consumir as APIs dos participantes

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.directory.opinbrasil.com.br/participants");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("data.directory.opinbrasil.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/participants", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://data.directory.opinbrasil.com.br/participants")
  .header("Accept", "application/json")
  .asString();

GET /participants

Example responses

200 Response

[
  {
    "OrganisationId": "string",
    "Status": "Active",
    "OrganisationName": "string",
    "CreatedOn": "string",
    "LegalEntityName": "string",
    "CountryOfRegistration": "string",
    "CompanyRegister": "string",
    "RegistrationNumber": "string",
    "RegistrationId": "string",
    "RegisteredName": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Postcode": "string",
    "Country": "string",
    "ParentOrganisationReference": "string",
    "Contacts": [
      {
        "ContactId": "string",
        "OrganisationId": "string",
        "ContactType": "Business",
        "FirstName": "string",
        "LastName": "string",
        "Department": "string",
        "EmailAddress": "string",
        "PhoneNumber": "string",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Postcode": "string",
        "Country": "string",
        "AdditionalInformation": "string",
        "PgpPublicKey": "string"
      }
    ],
    "AuthorisationServers": [
      {
        "AuthorisationServerId": "string",
        "OrganisationId": "string",
        "AutoRegistrationSupported": true,
        "ApiResources": [
          {
            "ApiResourceId": "string",
            "ApiFamilyType": "string",
            "ApiVersion": 0,
            "ApiDiscoveryEndpoints": [
              {
                "ApiDiscoveryId": "string",
                "ApiEndpoint": "http://example.com"
              }
            ]
          }
        ],
        "CustomerFriendlyDescription": "string",
        "CustomerFriendlyLogoUri": "http://example.com",
        "CustomerFriendlyName": "string",
        "DeveloperPortalUri": "http://example.com",
        "TermsOfServiceUri": "http://example.com",
        "NotificationWebhook": "http://example.com",
        "NotificationWebhookStatus": "string",
        "OpenIDDiscoveryDocument": "http://example.com",
        "PayloadSigningCertLocationUri": "http://example.com",
        "ParentAuthorisationServerId": "string"
      }
    ],
    "OrgDomainClaims": [
      {
        "OrganisationAuthorityDomainClaimId": "string",
        "AuthorisationDomainName": "string",
        "AuthorityId": "string",
        "AuthorityName": "string",
        "RegistrationId": "string",
        "Status": "Active"
      }
    ],
    "OrgDomainRoleClaims": [
      {
        "OrganisationId": "string",
        "OrganisationAuthorityClaimId": "string",
        "AuthorityId": "string",
        "Status": "Active",
        "AuthorisationDomain": "string",
        "Role": "string",
        "Authorisations": [
          {
            "Status": "Active",
            "MemberState": "st"
          }
        ],
        "RegistrationId": "string",
        "UniqueTechnicalIdenifier": [
          "string"
        ]
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Export the open-data for all the organisations OrganisationsExportOpenData
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found The specified key does not exist None
500 Internal Server Error Internal Server Error None
502 Bad Gateway Bad Gateway None

Especificações de APIs Diretório

O Diretório Central do Open Insurance Brasil pode ser acessado tanto via interface gráfica quanto por meio de integração por APIs.

Para acessar as APIs do Diretório, verifique os manuais para criação de certificados.

Criando uma Declaração de Software

Gerando o Certificado BRCAC

Gerando o Certificado BRSEAL

Obtendo um token para acesso as APIs do Diretório

Para entender como usar cada API, leia a especificação do Swagger da API do Diretório disponível nesse link.

Schemas

BadRequest

{
  "errors": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
errors [string] false none Validation Error messages

PageableRequest

{
  "page": 0,
  "size": 2,
  "sort": "status,desc"
}

Properties

Name Type Required Restrictions Description
page integer false none Page index starts from 0
size integer false none This sets the page size
sort string false none Used to sort based on Model Parameters

UserUpdateRequest

{
  "Status": "Active"
}

Properties

Name Type Required Restrictions Description
Status StatusEnum false none none

StatusEnum

"Active"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous Active
anonymous Inactive

OrganisationAuthorityClaims

[
  {
    "OrganisationId": "string",
    "OrganisationAuthorityClaimId": "string",
    "AuthorityId": "string",
    "Status": "Active",
    "AuthorisationDomain": "string",
    "Role": "string",
    "Authorisations": [
      {
        "Status": "Active",
        "MemberState": "st"
      }
    ],
    "RegistrationId": "string",
    "UniqueTechnicalIdenifier": [
      "string"
    ]
  }
]

Properties

Name Type Required Restrictions Description
anonymous [OrganisationAuthorityClaim] false none none

OrganisationAuthorityClaim

{
  "OrganisationId": "string",
  "OrganisationAuthorityClaimId": "string",
  "AuthorityId": "string",
  "Status": "Active",
  "AuthorisationDomain": "string",
  "Role": "string",
  "Authorisations": [
    {
      "Status": "Active",
      "MemberState": "st"
    }
  ],
  "RegistrationId": "string",
  "UniqueTechnicalIdenifier": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
OrganisationId OrganisationId false none Unique ID associated with the organisation
OrganisationAuthorityClaimId OrganisationAuthorityClaimId false none Unique ID associated with the authority claims
AuthorityId AuthorityId false none Unique ID associated with the Authorisation reference schema
Status string false none Is this software statement Active/Inactive
AuthorisationDomain string false none Authorisation Domain for the authority
Role string false none Roles for the Authority i.e. ASPSP, AISP, PISP, CBPII
Authorisations [object] false none none
» Status string false none Is this authorsation Active/Inactive
» MemberState string false none Abbreviated states information i.e. GB, IE, NL etc
RegistrationId string false none Registration ID for the organisation
UniqueTechnicalIdenifier [string] false none none

Enumerated Values

Property Value
Status Active
Status Inactive
Status Active
Status Inactive

OrganisationAuthorityClaimRequest

{
  "AuthorityId": "string",
  "Status": "Active",
  "AuthorisationDomain": "string",
  "Role": "string",
  "RegistrationId": "string",
  "UniqueTechnicalIdenifier": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
AuthorityId AuthorityId true none Unique ID associated with the Authorisation reference schema
Status string true none Is this authority claim Active/Inactive, default is Active
AuthorisationDomain string true none Authorisation domain for the authority
Role string true none Role for the authority
RegistrationId string true none Registration ID for the organisation
UniqueTechnicalIdenifier [string] false none none

Enumerated Values

Property Value
Status Active
Status Inactive

OrganisationAuthorityClaimAuthorisations

[
  {
    "OrganisationAuthorisationId": "string",
    "OrganisationAuthorityClaimId": "string",
    "Status": "Active",
    "MemberState": "string"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [OrganisationAuthorityClaimAuthorisation] false none none

OrganisationAuthorityClaimAuthorisation

{
  "OrganisationAuthorisationId": "string",
  "OrganisationAuthorityClaimId": "string",
  "Status": "Active",
  "MemberState": "string"
}

Properties

Name Type Required Restrictions Description
OrganisationAuthorisationId OrganisationAuthorisationId false none Unique ID associated with authorisations for organisation's authority claims
OrganisationAuthorityClaimId OrganisationAuthorityClaimId false none Unique ID associated with the authority claims
Status string false none Is this authority claim Active/Inactive
MemberState string false none Abbreviated states information i.e. GB, IE, NL etc

Enumerated Values

Property Value
Status Active
Status Inactive

OrganisationAuthorityClaimAuthorisationRequest

{
  "Status": "Active",
  "MemberState": "string"
}

Properties

Name Type Required Restrictions Description
Status string true none Is this Active/Inactive - default is Active
MemberState string true none Abbreviated states information i.e. GB, IE, NL etc

Enumerated Values

Property Value
Status Active
Status Inactive

AuthorisationServers

[
  {
    "AuthorisationServerId": "string",
    "OrganisationId": "string",
    "AutoRegistrationSupported": true,
    "ApiResources": [
      {
        "ApiResourceId": "string",
        "ApiFamilyType": "string",
        "ApiVersion": 0,
        "ApiDiscoveryEndpoints": [
          {
            "ApiDiscoveryId": "string",
            "ApiEndpoint": "http://example.com"
          }
        ]
      }
    ],
    "CustomerFriendlyDescription": "string",
    "CustomerFriendlyLogoUri": "http://example.com",
    "CustomerFriendlyName": "string",
    "DeveloperPortalUri": "http://example.com",
    "TermsOfServiceUri": "http://example.com",
    "NotificationWebhook": "http://example.com",
    "NotificationWebhookStatus": "string",
    "OpenIDDiscoveryDocument": "http://example.com",
    "PayloadSigningCertLocationUri": "http://example.com",
    "ParentAuthorisationServerId": "string"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [AuthorisationServer] false none none

AuthorisationServer

{
  "AuthorisationServerId": "string",
  "OrganisationId": "string",
  "AutoRegistrationSupported": true,
  "ApiResources": [
    {
      "ApiResourceId": "string",
      "ApiFamilyType": "string",
      "ApiVersion": 0,
      "ApiDiscoveryEndpoints": [
        {
          "ApiDiscoveryId": "string",
          "ApiEndpoint": "http://example.com"
        }
      ]
    }
  ],
  "CustomerFriendlyDescription": "string",
  "CustomerFriendlyLogoUri": "http://example.com",
  "CustomerFriendlyName": "string",
  "DeveloperPortalUri": "http://example.com",
  "TermsOfServiceUri": "http://example.com",
  "NotificationWebhook": "http://example.com",
  "NotificationWebhookStatus": "string",
  "OpenIDDiscoveryDocument": "http://example.com",
  "PayloadSigningCertLocationUri": "http://example.com",
  "ParentAuthorisationServerId": "string"
}

Properties

Name Type Required Restrictions Description
AuthorisationServerId AuthorisationServerId false none none
OrganisationId OrganisationId false none Unique ID associated with the organisation
AutoRegistrationSupported boolean false none none
ApiResources [ApiResource] false none none
CustomerFriendlyDescription string false none none
CustomerFriendlyLogoUri string(uri) false none A compliant URI
CustomerFriendlyName string false none none
DeveloperPortalUri string(uri) false none A compliant URI
TermsOfServiceUri string(uri) false none A compliant URI
NotificationWebhook string(uri) false none A compliant URI
NotificationWebhookStatus string false none If the webhook has confirmed subscription
OpenIDDiscoveryDocument string(uri) false none A compliant URI
PayloadSigningCertLocationUri string(uri) false none A compliant URI
ParentAuthorisationServerId AuthorisationServerId false none none

AuthorisationServerRequest

{
  "AutoRegistrationSupported": true,
  "CustomerFriendlyDescription": "string",
  "CustomerFriendlyLogoUri": "string",
  "CustomerFriendlyName": "string",
  "DeveloperPortalUri": "string",
  "TermsOfServiceUri": "string",
  "NotificationWebhook": "string",
  "OpenIDDiscoveryDocument": "string",
  "PayloadSigningCertLocationUri": "string",
  "ParentAuthorisationServerId": "string"
}

Properties

Name Type Required Restrictions Description
AutoRegistrationSupported boolean true none Default is true
CustomerFriendlyDescription string false none A customer friendly description
CustomerFriendlyLogoUri string true none A compliant URI
CustomerFriendlyName string true none none
DeveloperPortalUri string true none A compliant URI
TermsOfServiceUri string true none A compliant URI
NotificationWebhook string false none A compliant URI
OpenIDDiscoveryDocument string true none A compliant URI
PayloadSigningCertLocationUri string true none A compliant URI
ParentAuthorisationServerId AuthorisationServerId false none none

AuthorisationServerId

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

CertificateOrKeyOrJWT

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

CertificateOrKeyId

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

CertificatesOrKeys

[
  {
    "OrganisationId": "string",
    "SoftwareStatementIds": [
      "string"
    ],
    "ClientName": "string",
    "Status": "string",
    "ValidFromDateTime": "string",
    "ExpiryDateTime": "string",
    "e": "string",
    "keyType": "string",
    "kid": "string",
    "kty": "string",
    "n": "string",
    "use": "string",
    "x5c": [
      "string"
    ],
    "x5t": "string",
    "x5thashS256": "string",
    "x5u": "string",
    "SignedCertPath": "string",
    "JwkPath": "string",
    "OrgJwkPath": "string"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [CertificateOrKey] false none none

CertificateOrKey

{
  "OrganisationId": "string",
  "SoftwareStatementIds": [
    "string"
  ],
  "ClientName": "string",
  "Status": "string",
  "ValidFromDateTime": "string",
  "ExpiryDateTime": "string",
  "e": "string",
  "keyType": "string",
  "kid": "string",
  "kty": "string",
  "n": "string",
  "use": "string",
  "x5c": [
    "string"
  ],
  "x5t": "string",
  "x5thashS256": "string",
  "x5u": "string",
  "SignedCertPath": "string",
  "JwkPath": "string",
  "OrgJwkPath": "string"
}

Properties

Name Type Required Restrictions Description
OrganisationId OrganisationId false none Unique ID associated with the organisation
SoftwareStatementIds [SoftwareStatementId] false none [Unique Software Statement Id]
ClientName string false none none
Status string false none none
ValidFromDateTime string false none none
ExpiryDateTime string false none none
e string false none none
keyType string false none none
kid string false none none
kty string false none none
n string false none none
use string false none none
x5c [string] false none none
x5t string false none none
x5thashS256 string false none none
x5u string false none none
SignedCertPath string false none Used to display location of the signed certificate in PEM format
JwkPath string false none Used to display path to JWKS containing this certificate
OrgJwkPath string false none Used to display path to Org JWKS containing org certificates

AmendCertificateRequest

{
  "RevokeReason": "unspecified"
}

Properties

Name Type Required Restrictions Description
RevokeReason string true none Specify a reason for revokation of the certificate.

Enumerated Values

Property Value
RevokeReason unspecified
RevokeReason keycompromise
RevokeReason superseded
RevokeReason cessationofoperation
RevokeReason privilegewithdrawn

ContactRequest

{
  "ContactType": "Business",
  "FirstName": "string",
  "LastName": "string",
  "Department": "string",
  "EmailAddress": "string",
  "PhoneNumber": "stringst",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Postcode": "string",
  "Country": "string",
  "AdditionalInformation": "string",
  "PgpPublicKey": "string"
}

Properties

Name Type Required Restrictions Description
ContactType string true none The type of Contact, default contact type is Business.
FirstName string false none none
LastName string false none none
Department string false none none
EmailAddress string true none none
PhoneNumber string true none none
AddressLine1 string false none Address line 1
AddressLine2 string false none Address line 2
City string false none City
Postcode string false none Postcode
Country string false none Country
AdditionalInformation string false none Any additional user information
PgpPublicKey string false none A PGP Public Key in text form

Enumerated Values

Property Value
ContactType Business
ContactType Technical
ContactType Billing
ContactType Incident
ContactType Security

Contacts

[
  {
    "ContactId": "string",
    "OrganisationId": "string",
    "ContactType": "Business",
    "FirstName": "string",
    "LastName": "string",
    "Department": "string",
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Postcode": "string",
    "Country": "string",
    "AdditionalInformation": "string",
    "PgpPublicKey": "string"
  }
]

The list of contacts

Properties

Name Type Required Restrictions Description
anonymous [Contact] false none The list of contacts

Contact

{
  "ContactId": "string",
  "OrganisationId": "string",
  "ContactType": "Business",
  "FirstName": "string",
  "LastName": "string",
  "Department": "string",
  "EmailAddress": "string",
  "PhoneNumber": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Postcode": "string",
  "Country": "string",
  "AdditionalInformation": "string",
  "PgpPublicKey": "string"
}

Properties

Name Type Required Restrictions Description
ContactId string false none Unique contact ID for the row.
OrganisationId OrganisationId false none Unique ID associated with the organisation
ContactType string false none none
FirstName string false none none
LastName string false none none
Department string false none none
EmailAddress string false none none
PhoneNumber string false none none
AddressLine1 string false none Address line 1
AddressLine2 string false none Address line 2
City string false none City
Postcode string false none Postcode
Country string false none Country
AdditionalInformation string false none Any additional user information
PgpPublicKey string false none A PGP Public Key in text form

Enumerated Values

Property Value
ContactType Business
ContactType Technical
ContactType Billing
ContactType Incident
ContactType Security

ContactId

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

OrganisationRequest

{
  "OrganisationId": "string",
  "Status": "Active",
  "OrganisationName": "string",
  "LegalEntityName": "string",
  "CountryOfRegistration": "string",
  "CompanyRegister": "string",
  "RegistrationNumber": "string",
  "RegistrationId": "string",
  "RegisteredName": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Postcode": "string",
  "Country": "string",
  "ParentOrganisationReference": "string"
}

Properties

Name Type Required Restrictions Description
OrganisationId OrganisationId true none Unique ID associated with the organisation
Status string false none Status of the directory registration of an organisation
OrganisationName string true none none
LegalEntityName string true none Legal Entity name for the org. Usually the same as org name
CountryOfRegistration string true none Country of registration for the org
CompanyRegister string true none Legal company register for the country, i.e. Companies House
RegistrationNumber string true none Company registration number from company register i.e. Companies House registration number
RegistrationId string false none Registered ID for the organisation i.e. Legal Entity identifier number
RegisteredName string false none Registered legal name
AddressLine1 string true none Address line 1
AddressLine2 string false none Address line 2
City string true none City
Postcode string true none Postcode
Country string true none Country
ParentOrganisationReference string false none Parent Organisation Reference

Enumerated Values

Property Value
Status Active
Status Pending
Status Withdrawn

OrganisationUpdateRequest

{
  "Status": "Active",
  "OrganisationName": "string",
  "LegalEntityName": "string",
  "CountryOfRegistration": "string",
  "CompanyRegister": "string",
  "RegistrationNumber": "string",
  "RegistrationId": "string",
  "RegisteredName": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Postcode": "string",
  "Country": "string",
  "ParentOrganisationReference": "string"
}

Properties

Name Type Required Restrictions Description
Status string false none Status of the directory registration of an organisation
OrganisationName string true none none
LegalEntityName string true none Legal Entity name for the org. Usually the same as org name
CountryOfRegistration string true none Country of registration for the org
CompanyRegister string true none Legal company register for the country, i.e. Companies House
RegistrationNumber string true none Company registration number from company register i.e. Companies House registration number
RegistrationId string false none Registered ID for the organisation i.e. Legal Entity identifier number
RegisteredName string false none Registered legal name
AddressLine1 string true none Address line 1
AddressLine2 string false none Address line 2
City string true none City
Postcode string true none Postcode
Country string true none Country
ParentOrganisationReference string false none Parent Organisation Reference

Enumerated Values

Property Value
Status Active
Status Pending
Status Withdrawn

OrganisationEnrol

{
  "RedirectUris": [
    "http://example.com"
  ],
  "TokenEndpointAuthMethod": "string",
  "GrantTypes": [
    "string"
  ],
  "ResponseTypes": [
    "string"
  ],
  "ClientName": "string",
  "ClientUri": "http://example.com",
  "LogoUri": "http://example.com",
  "Scope": "string",
  "TosUri": "http://example.com",
  "PolicyUri": "http://example.com"
}

Properties

Name Type Required Restrictions Description
RedirectUris [string] true none none
TokenEndpointAuthMethod string true none none
GrantTypes [string] true none none
ResponseTypes [string] true none none
ClientName number true none ORG name as per eIDAS certificate
ClientUri string(uri) true none A compliant URI
LogoUri string(uri) true none A compliant URI
Scope string true none none
TosUri string(uri) true none A compliant URI
PolicyUri string(uri) true none A compliant URI

OrganisationEnrolments

[
  {
    "OrganisationId": "string",
    "ClientSecret": "string",
    "RedirectUris": [
      "http://example.com"
    ],
    "TokenEndpointAuthMethod": "string",
    "GrantTypes": [
      "string"
    ],
    "ResponseTypes": [
      "string"
    ],
    "ClientName": "string",
    "ClientUri": "http://example.com",
    "LogoUri": "http://example.com",
    "TosUri": "http://example.com",
    "PolicyUri": "http://example.com",
    "JwksUri": "http://example.com",
    "Jwks": {}
  }
]

A JSON object DCR response returned when client gets created.

Properties

Name Type Required Restrictions Description
OrganisationId OrganisationId false none Unique ID associated with the organisation
ClientSecret string false none Client secret generated by Directory
RedirectUris [string] false none none
TokenEndpointAuthMethod string false none none
GrantTypes [string] false none none
ResponseTypes [string] false none none
ClientName string false none ORG name as per eIDAS certificate
ClientUri string(uri) false none A compliant URI string of a web page providing information about the client
LogoUri string(uri) false none A compliant URI
TosUri string(uri) false none A compliant URI string that points to a human-readable terms of service document for the client
PolicyUri string(uri) false none A compliant URI string that points to a human-readable privacy policy document
JwksUri string(uri) false none A compliant URI string referencing the client's JSON Web Key (JWK) Set
Jwks object false none Client's JSON Web Key Set [RFC7517] document value

OrganisationCertificateType

"qwac"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous qwac
anonymous qseal
anonymous rtswac
anonymous rtsseal

OrganisationId

"string"

Unique ID associated with the organisation

Properties

Name Type Required Restrictions Description
anonymous string false none Unique ID associated with the organisation

OrganisationAuthorityClaimId

"string"

Unique ID associated with the authority claims

Properties

Name Type Required Restrictions Description
anonymous string false none Unique ID associated with the authority claims

OrganisationAuthorisationId

"string"

Unique ID associated with authorisations for organisation's authority claims

Properties

Name Type Required Restrictions Description
anonymous string false none Unique ID associated with authorisations for organisation's authority claims

SoftwareAuthorityClaimId

"string"

Unique ID associated with the authority claims for a software statement

Properties

Name Type Required Restrictions Description
anonymous string false none Unique ID associated with the authority claims for a software statement

AuthorityId

"string"

Unique ID associated with the Authorisation reference schema

Properties

Name Type Required Restrictions Description
anonymous string false none Unique ID associated with the Authorisation reference schema

Organisations

[
  {
    "OrganisationId": "string",
    "Status": "Active",
    "OrganisationName": "string",
    "CreatedOn": "string",
    "LegalEntityName": "string",
    "CountryOfRegistration": "string",
    "CompanyRegister": "string",
    "RegistrationNumber": "string",
    "RegistrationId": "string",
    "RegisteredName": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Postcode": "string",
    "Country": "string",
    "ParentOrganisationReference": "string",
    "RequiresSigning": true,
    "TnCUpdated": true,
    "TnCsToBeSigned": [
      {
        "TnCId": 0,
        "Version": 0,
        "Name": "string",
        "Type": "string",
        "Content": "string",
        "Status": "Active",
        "ExternalSigningService": {
          "ExternalSigningServiceName": "DocuSign",
          "ExternalSigningServiceSignerTemplateConfig": {
            "TemplateIdSigner1": "string",
            "TemplateIdSigner2": "string",
            "TemplateIdSigner3": "string",
            "TemplateIdSigner4": "string",
            "TemplateIdSigner5": "string",
            "TemplateIdSigner6": "string"
          },
          "ExternalSigningServiceSubject": "string"
        }
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
anonymous [Organisation] false none none

Organisation

{
  "OrganisationId": "string",
  "Status": "Active",
  "OrganisationName": "string",
  "CreatedOn": "string",
  "LegalEntityName": "string",
  "CountryOfRegistration": "string",
  "CompanyRegister": "string",
  "RegistrationNumber": "string",
  "RegistrationId": "string",
  "RegisteredName": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Postcode": "string",
  "Country": "string",
  "ParentOrganisationReference": "string",
  "RequiresSigning": true,
  "TnCUpdated": true,
  "TnCsToBeSigned": [
    {
      "TnCId": 0,
      "Version": 0,
      "Name": "string",
      "Type": "string",
      "Content": "string",
      "Status": "Active",
      "ExternalSigningService": {
        "ExternalSigningServiceName": "DocuSign",
        "ExternalSigningServiceSignerTemplateConfig": {
          "TemplateIdSigner1": "string",
          "TemplateIdSigner2": "string",
          "TemplateIdSigner3": "string",
          "TemplateIdSigner4": "string",
          "TemplateIdSigner5": "string",
          "TemplateIdSigner6": "string"
        },
        "ExternalSigningServiceSubject": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
OrganisationId OrganisationId false none Unique ID associated with the organisation
Status string false none Status of the directory registration of an organisation
OrganisationName string false none Name of the organisation.
CreatedOn string false none JSONDatetime of organisation creation.
LegalEntityName string false none Legal Entity name for the org. Usually the same as org name
CountryOfRegistration string false none Country of registration for the org
CompanyRegister string false none Legal company register for the country, i.e. Companies House
RegistrationNumber string false none Company registration number from company register i.e. Companies House registration number
RegistrationId string false none Registered ID for the organisation i.e. Legal Entity identifier number
RegisteredName string false none none
AddressLine1 string false none Address line 1
AddressLine2 string false none Address line 2
City string false none City
Postcode string false none Postcode
Country string false none Country
ParentOrganisationReference string false none Parent Organisation Reference
RequiresSigning boolean false none true - one of the attached tncs has to be signed. false - no tnc present
TnCUpdated boolean false none true - attached tnc has been update. false - no tnc present
TnCsToBeSigned TnCsToBeSigned false none none

Enumerated Values

Property Value
Status Active
Status Pending
Status Withdrawn

OrgTermsAndConditionsDetail

{
  "InitiatedBy": "string",
  "Role": "string",
  "TermsAndConditionsDetail": {
    "TermsAndConditionsItem": {
      "TnCId": 0,
      "Version": 0,
      "Name": "string",
      "Type": "string",
      "Content": "string",
      "Status": "Active",
      "ExternalSigningService": {
        "ExternalSigningServiceName": "DocuSign",
        "ExternalSigningServiceSignerTemplateConfig": {
          "TemplateIdSigner1": "string",
          "TemplateIdSigner2": "string",
          "TemplateIdSigner3": "string",
          "TemplateIdSigner4": "string",
          "TemplateIdSigner5": "string",
          "TemplateIdSigner6": "string"
        },
        "ExternalSigningServiceSubject": "string"
      }
    },
    "InititatedDate": "string",
    "ExternalSigningServiceEnvelopeId": "string",
    "ExternalSigningServiceEnvelopeStatus": "Completed",
    "ExternalSigningServiceEnvelopePasscode": "string"
  }
}

Participant TnC details

Properties

Name Type Required Restrictions Description
InitiatedBy string false none Email of the user who initiated the External signing for this participant
Role string false none Role of the user who initiated the External signing for this participant
TermsAndConditionsDetail TermsAndConditionsDetail false none TnC details Parent

TermsAndConditionsDetail

{
  "TermsAndConditionsItem": {
    "TnCId": 0,
    "Version": 0,
    "Name": "string",
    "Type": "string",
    "Content": "string",
    "Status": "Active",
    "ExternalSigningService": {
      "ExternalSigningServiceName": "DocuSign",
      "ExternalSigningServiceSignerTemplateConfig": {
        "TemplateIdSigner1": "string",
        "TemplateIdSigner2": "string",
        "TemplateIdSigner3": "string",
        "TemplateIdSigner4": "string",
        "TemplateIdSigner5": "string",
        "TemplateIdSigner6": "string"
      },
      "ExternalSigningServiceSubject": "string"
    }
  },
  "InititatedDate": "string",
  "ExternalSigningServiceEnvelopeId": "string",
  "ExternalSigningServiceEnvelopeStatus": "Completed",
  "ExternalSigningServiceEnvelopePasscode": "string"
}

TnC details Parent

Properties

Name Type Required Restrictions Description
TermsAndConditionsItem TermsAndConditionsItem false none none
InititatedDate string false none Terms and Conditions initiated date
ExternalSigningServiceEnvelopeId ExternalSigningServiceEnvelopeId false none The envelope id of the ess signing request
ExternalSigningServiceEnvelopeStatus ExternalSigningServiceEnvelopeStatus false none none
ExternalSigningServiceEnvelopePasscode string false none Access code for the specifier to fill in the signer details. This will be populated only once, when signing is initiated

ExternalSigningServiceEnvelopeStatus

"Completed"

Properties

None

OrganisationSnapshotPage

{
  "totalPages": 0,
  "totalSize": 0,
  "pageable": {
    "number": 0,
    "sort": {
      "sorted": true,
      "orderBy": [
        {
          "property": "createdAt",
          "direction": "ASC",
          "ignoreCase": true,
          "ascending": true
        }
      ]
    },
    "size": 0,
    "offset": 0,
    "sorted": true
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "OrganisationDetails": {
        "OrganisationId": "string",
        "Status": "Active",
        "OrganisationName": "string",
        "CreatedOn": "string",
        "LegalEntityName": "string",
        "CountryOfRegistration": "string",
        "CompanyRegister": "string",
        "RegistrationNumber": "string",
        "RegistrationId": "string",
        "RegisteredName": "string",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Postcode": "string",
        "Country": "string",
        "ParentOrganisationReference": "string",
        "RequiresSigning": true,
        "TnCUpdated": true,
        "TnCsToBeSigned": [
          {
            "TnCId": 0,
            "Version": 0,
            "Name": "string",
            "Type": "string",
            "Content": "string",
            "Status": "Active",
            "ExternalSigningService": {
              "ExternalSigningServiceName": "DocuSign",
              "ExternalSigningServiceSignerTemplateConfig": {
                "TemplateIdSigner1": "string",
                "TemplateIdSigner2": "string",
                "TemplateIdSigner3": "string",
                "TemplateIdSigner4": "string",
                "TemplateIdSigner5": "string",
                "TemplateIdSigner6": "string"
              },
              "ExternalSigningServiceSubject": "string"
            }
          }
        ]
      },
      "Contacts": [
        {
          "ContactId": "string",
          "OrganisationId": "string",
          "ContactType": "Business",
          "FirstName": "string",
          "LastName": "string",
          "Department": "string",
          "EmailAddress": "string",
          "PhoneNumber": "string",
          "AddressLine1": "string",
          "AddressLine2": "string",
          "City": "string",
          "Postcode": "string",
          "Country": "string",
          "AdditionalInformation": "string",
          "PgpPublicKey": "string"
        }
      ],
      "AuthorisationServers": [
        {
          "AuthorisationServerId": "string",
          "OrganisationId": "string",
          "AutoRegistrationSupported": true,
          "ApiResources": [
            {
              "ApiResourceId": "string",
              "ApiFamilyType": "string",
              "ApiVersion": 0,
              "ApiDiscoveryEndpoints": [
                {
                  "ApiDiscoveryId": "string",
                  "ApiEndpoint": "http://example.com"
                }
              ]
            }
          ],
          "CustomerFriendlyDescription": "string",
          "CustomerFriendlyLogoUri": "http://example.com",
          "CustomerFriendlyName": "string",
          "DeveloperPortalUri": "http://example.com",
          "TermsOfServiceUri": "http://example.com",
          "NotificationWebhook": "http://example.com",
          "NotificationWebhookStatus": "string",
          "OpenIDDiscoveryDocument": "http://example.com",
          "PayloadSigningCertLocationUri": "http://example.com",
          "ParentAuthorisationServerId": "string"
        }
      ],
      "OrgDomainClaims": [
        {
          "OrganisationAuthorityDomainClaimId": "string",
          "AuthorisationDomainName": "string",
          "AuthorityId": "string",
          "AuthorityName": "string",
          "RegistrationId": "string",
          "Status": "Active"
        }
      ],
      "OrgDomainRoleClaims": [
        {
          "OrganisationId": "string",
          "OrganisationAuthorityClaimId": "string",
          "AuthorityId": "string",
          "Status": "Active",
          "AuthorisationDomain": "string",
          "Role": "string",
          "Authorisations": [
            {
              "Status": "Active",
              "MemberState": "st"
            }
          ],
          "RegistrationId": "string",
          "UniqueTechnicalIdenifier": [
            "string"
          ]
        }
      ],
      "SoftwareStatements": {
        "property1": {
          "SoftwareDetails": {
            "Status": "Active",
            "ClientId": "string",
            "ClientName": "string",
            "Description": "string",
            "Environment": "string",
            "OrganisationId": "string",
            "SoftwareStatementId": "string",
            "Mode": "Live",
            "RtsClientCreated": true,
            "OnBehalfOf": "string",
            "PolicyUri": "string",
            "ClientUri": "string",
            "LogoUri": "http://example.com",
            "RedirectUri": [
              "http://example.com"
            ],
            "TermsOfServiceUri": "http://example.com",
            "Version": 0,
            "Locked": true
          },
          "SoftwareAuthorityClaims": [
            {
              "SoftwareStatementId": "string",
              "SoftwareAuthorityClaimId": "string",
              "Status": "Active",
              "AuthorisationDomain": "string",
              "Role": "string"
            }
          ],
          "SoftwareCertificates": [
            {
              "OrganisationId": "string",
              "SoftwareStatementIds": [
                "string"
              ],
              "ClientName": "string",
              "Status": "string",
              "ValidFromDateTime": "string",
              "ExpiryDateTime": "string",
              "e": "string",
              "keyType": "string",
              "kid": "string",
              "kty": "string",
              "n": "string",
              "use": "string",
              "x5c": [
                "string"
              ],
              "x5t": "string",
              "x5thashS256": "string",
              "x5u": "string",
              "SignedCertPath": "string",
              "JwkPath": "string",
              "OrgJwkPath": "string"
            }
          ]
        },
        "property2": {
          "SoftwareDetails": {
            "Status": "Active",
            "ClientId": "string",
            "ClientName": "string",
            "Description": "string",
            "Environment": "string",
            "OrganisationId": "string",
            "SoftwareStatementId": "string",
            "Mode": "Live",
            "RtsClientCreated": true,
            "OnBehalfOf": "string",
            "PolicyUri": "string",
            "ClientUri": "string",
            "LogoUri": "http://example.com",
            "RedirectUri": [
              "http://example.com"
            ],
            "TermsOfServiceUri": "http://example.com",
            "Version": 0,
            "Locked": true
          },
          "SoftwareAuthorityClaims": [
            {
              "SoftwareStatementId": "string",
              "SoftwareAuthorityClaimId": "string",
              "Status": "Active",
              "AuthorisationDomain": "string",
              "Role": "string"
            }
          ],
          "SoftwareCertificates": [
            {
              "OrganisationId": "string",
              "SoftwareStatementIds": [
                "string"
              ],
              "ClientName": "string",
              "Status": "string",
              "ValidFromDateTime": "string",
              "ExpiryDateTime": "string",
              "e": "string",
              "keyType": "string",
              "kid": "string",
              "kty": "string",
              "n": "string",
              "use": "string",
              "x5c": [
                "string"
              ],
              "x5t": "string",
              "x5thashS256": "string",
              "x5u": "string",
              "SignedCertPath": "string",
              "JwkPath": "string",
              "OrgJwkPath": "string"
            }
          ]
        }
      }
    }
  ],
  "offset": 0,
  "empty": true,
  "pageNumber": 0
}

Properties

Name Type Required Restrictions Description
totalPages integer false none none
totalSize integer false none none
pageable Pageable false none none
numberOfElements integer false none none
size integer false none none
content [OrganisationSnapshot] false none none
offset integer false none none
empty boolean false none none
pageNumber integer false none none

Pageable

{
  "number": 0,
  "sort": {
    "sorted": true,
    "orderBy": [
      {
        "property": "createdAt",
        "direction": "ASC",
        "ignoreCase": true,
        "ascending": true
      }
    ]
  },
  "size": 0,
  "offset": 0,
  "sorted": true
}

Properties

Name Type Required Restrictions Description
number integer false none Page number
sort Sort false none none
size integer false none Size of the page
offset integer false none Offset
sorted boolean false none Is the page sorted

Sort

{
  "sorted": true,
  "orderBy": [
    {
      "property": "createdAt",
      "direction": "ASC",
      "ignoreCase": true,
      "ascending": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
sorted boolean false none none
orderBy [object] false none none
» property string false none Name of the property used for sorting
» direction string false none Direction of sort, i.e. ascending or descending
» ignoreCase boolean false none Was the case ignored
» ascending boolean false none Whether ascending

Enumerated Values

Property Value
direction ASC
direction DESC

OrganisationsSnapshot

{
  "property1": {
    "OrganisationDetails": {
      "OrganisationId": "string",
      "Status": "Active",
      "OrganisationName": "string",
      "CreatedOn": "string",
      "LegalEntityName": "string",
      "CountryOfRegistration": "string",
      "CompanyRegister": "string",
      "RegistrationNumber": "string",
      "RegistrationId": "string",
      "RegisteredName": "string",
      "AddressLine1": "string",
      "AddressLine2": "string",
      "City": "string",
      "Postcode": "string",
      "Country": "string",
      "ParentOrganisationReference": "string",
      "RequiresSigning": true,
      "TnCUpdated": true,
      "TnCsToBeSigned": [
        {
          "TnCId": 0,
          "Version": 0,
          "Name": "string",
          "Type": "string",
          "Content": "string",
          "Status": "Active",
          "ExternalSigningService": {
            "ExternalSigningServiceName": "DocuSign",
            "ExternalSigningServiceSignerTemplateConfig": {
              "TemplateIdSigner1": "string",
              "TemplateIdSigner2": "string",
              "TemplateIdSigner3": "string",
              "TemplateIdSigner4": "string",
              "TemplateIdSigner5": "string",
              "TemplateIdSigner6": "string"
            },
            "ExternalSigningServiceSubject": "string"
          }
        }
      ]
    },
    "Contacts": [
      {
        "ContactId": "string",
        "OrganisationId": "string",
        "ContactType": "Business",
        "FirstName": "string",
        "LastName": "string",
        "Department": "string",
        "EmailAddress": "string",
        "PhoneNumber": "string",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Postcode": "string",
        "Country": "string",
        "AdditionalInformation": "string",
        "PgpPublicKey": "string"
      }
    ],
    "AuthorisationServers": [
      {
        "AuthorisationServerId": "string",
        "OrganisationId": "string",
        "AutoRegistrationSupported": true,
        "ApiResources": [
          {
            "ApiResourceId": "string",
            "ApiFamilyType": "string",
            "ApiVersion": 0,
            "ApiDiscoveryEndpoints": [
              {
                "ApiDiscoveryId": "string",
                "ApiEndpoint": "http://example.com"
              }
            ]
          }
        ],
        "CustomerFriendlyDescription": "string",
        "CustomerFriendlyLogoUri": "http://example.com",
        "CustomerFriendlyName": "string",
        "DeveloperPortalUri": "http://example.com",
        "TermsOfServiceUri": "http://example.com",
        "NotificationWebhook": "http://example.com",
        "NotificationWebhookStatus": "string",
        "OpenIDDiscoveryDocument": "http://example.com",
        "PayloadSigningCertLocationUri": "http://example.com",
        "ParentAuthorisationServerId": "string"
      }
    ],
    "OrgDomainClaims": [
      {
        "OrganisationAuthorityDomainClaimId": "string",
        "AuthorisationDomainName": "string",
        "AuthorityId": "string",
        "AuthorityName": "string",
        "RegistrationId": "string",
        "Status": "Active"
      }
    ],
    "OrgDomainRoleClaims": [
      {
        "OrganisationId": "string",
        "OrganisationAuthorityClaimId": "string",
        "AuthorityId": "string",
        "Status": "Active",
        "AuthorisationDomain": "string",
        "Role": "string",
        "Authorisations": [
          {
            "Status": "Active",
            "MemberState": "st"
          }
        ],
        "RegistrationId": "string",
        "UniqueTechnicalIdenifier": [
          "string"
        ]
      }
    ],
    "SoftwareStatements": {
      "property1": {
        "SoftwareDetails": {
          "Status": "Active",
          "ClientId": "string",
          "ClientName": "string",
          "Description": "string",
          "Environment": "string",
          "OrganisationId": "string",
          "SoftwareStatementId": "string",
          "Mode": "Live",
          "RtsClientCreated": true,
          "OnBehalfOf": "string",
          "PolicyUri": "string",
          "ClientUri": "string",
          "LogoUri": "http://example.com",
          "RedirectUri": [
            "http://example.com"
          ],
          "TermsOfServiceUri": "http://example.com",
          "Version": 0,
          "Locked": true
        },
        "SoftwareAuthorityClaims": [
          {
            "SoftwareStatementId": "string",
            "SoftwareAuthorityClaimId": "string",
            "Status": "Active",
            "AuthorisationDomain": "string",
            "Role": "string"
          }
        ],
        "SoftwareCertificates": [
          {
            "OrganisationId": "string",
            "SoftwareStatementIds": [
              "string"
            ],
            "ClientName": "string",
            "Status": "string",
            "ValidFromDateTime": "string",
            "ExpiryDateTime": "string",
            "e": "string",
            "keyType": "string",
            "kid": "string",
            "kty": "string",
            "n": "string",
            "use": "string",
            "x5c": [
              "string"
            ],
            "x5t": "string",
            "x5thashS256": "string",
            "x5u": "string",
            "SignedCertPath": "string",
            "JwkPath": "string",
            "OrgJwkPath": "string"
          }
        ]
      },
      "property2": {
        "SoftwareDetails": {
          "Status": "Active",
          "ClientId": "string",
          "ClientName": "string",
          "Description": "string",
          "Environment": "string",
          "OrganisationId": "string",
          "SoftwareStatementId": "string",
          "Mode": "Live",
          "RtsClientCreated": true,
          "OnBehalfOf": "string",
          "PolicyUri": "string",
          "ClientUri": "string",
          "LogoUri": "http://example.com",
          "RedirectUri": [
            "http://example.com"
          ],
          "TermsOfServiceUri": "http://example.com",
          "Version": 0,
          "Locked": true
        },
        "SoftwareAuthorityClaims": [
          {
            "SoftwareStatementId": "string",
            "SoftwareAuthorityClaimId": "string",
            "Status": "Active",
            "AuthorisationDomain": "string",
            "Role": "string"
          }
        ],
        "SoftwareCertificates": [
          {
            "OrganisationId": "string",
            "SoftwareStatementIds": [
              "string"
            ],
            "ClientName": "string",
            "Status": "string",
            "ValidFromDateTime": "string",
            "ExpiryDateTime": "string",
            "e": "string",
            "keyType": "string",
            "kid": "string",
            "kty": "string",
            "n": "string",
            "use": "string",
            "x5c": [
              "string"
            ],
            "x5t": "string",
            "x5thashS256": "string",
            "x5u": "string",
            "SignedCertPath": "string",
            "JwkPath": "string",
            "OrgJwkPath": "string"
          }
        ]
      }
    }
  },
  "property2": {
    "OrganisationDetails": {
      "OrganisationId": "string",
      "Status": "Active",
      "OrganisationName": "string",
      "CreatedOn": "string",
      "LegalEntityName": "string",
      "CountryOfRegistration": "string",
      "CompanyRegister": "string",
      "RegistrationNumber": "string",
      "RegistrationId": "string",
      "RegisteredName": "string",
      "AddressLine1": "string",
      "AddressLine2": "string",
      "City": "string",
      "Postcode": "string",
      "Country": "string",
      "ParentOrganisationReference": "string",
      "RequiresSigning": true,
      "TnCUpdated": true,
      "TnCsToBeSigned": [
        {
          "TnCId": 0,
          "Version": 0,
          "Name": "string",
          "Type": "string",
          "Content": "string",
          "Status": "Active",
          "ExternalSigningService": {
            "ExternalSigningServiceName": "DocuSign",
            "ExternalSigningServiceSignerTemplateConfig": {
              "TemplateIdSigner1": "string",
              "TemplateIdSigner2": "string",
              "TemplateIdSigner3": "string",
              "TemplateIdSigner4": "string",
              "TemplateIdSigner5": "string",
              "TemplateIdSigner6": "string"
            },
            "ExternalSigningServiceSubject": "string"
          }
        }
      ]
    },
    "Contacts": [
      {
        "ContactId": "string",
        "OrganisationId": "string",
        "ContactType": "Business",
        "FirstName": "string",
        "LastName": "string",
        "Department": "string",
        "EmailAddress": "string",
        "PhoneNumber": "string",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Postcode": "string",
        "Country": "string",
        "AdditionalInformation": "string",
        "PgpPublicKey": "string"
      }
    ],
    "AuthorisationServers": [
      {
        "AuthorisationServerId": "string",
        "OrganisationId": "string",
        "AutoRegistrationSupported": true,
        "ApiResources": [
          {
            "ApiResourceId": "string",
            "ApiFamilyType": "string",
            "ApiVersion": 0,
            "ApiDiscoveryEndpoints": [
              {
                "ApiDiscoveryId": "string",
                "ApiEndpoint": "http://example.com"
              }
            ]
          }
        ],
        "CustomerFriendlyDescription": "string",
        "CustomerFriendlyLogoUri": "http://example.com",
        "CustomerFriendlyName": "string",
        "DeveloperPortalUri": "http://example.com",
        "TermsOfServiceUri": "http://example.com",
        "NotificationWebhook": "http://example.com",
        "NotificationWebhookStatus": "string",
        "OpenIDDiscoveryDocument": "http://example.com",
        "PayloadSigningCertLocationUri": "http://example.com",
        "ParentAuthorisationServerId": "string"
      }
    ],
    "OrgDomainClaims": [
      {
        "OrganisationAuthorityDomainClaimId": "string",
        "AuthorisationDomainName": "string",
        "AuthorityId": "string",
        "AuthorityName": "string",
        "RegistrationId": "string",
        "Status": "Active"
      }
    ],
    "OrgDomainRoleClaims": [
      {
        "OrganisationId": "string",
        "OrganisationAuthorityClaimId": "string",
        "AuthorityId": "string",
        "Status": "Active",
        "AuthorisationDomain": "string",
        "Role": "string",
        "Authorisations": [
          {
            "Status": "Active",
            "MemberState": "st"
          }
        ],
        "RegistrationId": "string",
        "UniqueTechnicalIdenifier": [
          "string"
        ]
      }
    ],
    "SoftwareStatements": {
      "property1": {
        "SoftwareDetails": {
          "Status": "Active",
          "ClientId": "string",
          "ClientName": "string",
          "Description": "string",
          "Environment": "string",
          "OrganisationId": "string",
          "SoftwareStatementId": "string",
          "Mode": "Live",
          "RtsClientCreated": true,
          "OnBehalfOf": "string",
          "PolicyUri": "string",
          "ClientUri": "string",
          "LogoUri": "http://example.com",
          "RedirectUri": [
            "http://example.com"
          ],
          "TermsOfServiceUri": "http://example.com",
          "Version": 0,
          "Locked": true
        },
        "SoftwareAuthorityClaims": [
          {
            "SoftwareStatementId": "string",
            "SoftwareAuthorityClaimId": "string",
            "Status": "Active",
            "AuthorisationDomain": "string",
            "Role": "string"
          }
        ],
        "SoftwareCertificates": [
          {
            "OrganisationId": "string",
            "SoftwareStatementIds": [
              "string"
            ],
            "ClientName": "string",
            "Status": "string",
            "ValidFromDateTime": "string",
            "ExpiryDateTime": "string",
            "e": "string",
            "keyType": "string",
            "kid": "string",
            "kty": "string",
            "n": "string",
            "use": "string",
            "x5c": [
              "string"
            ],
            "x5t": "string",
            "x5thashS256": "string",
            "x5u": "string",
            "SignedCertPath": "string",
            "JwkPath": "string",
            "OrgJwkPath": "string"
          }
        ]
      },
      "property2": {
        "SoftwareDetails": {
          "Status": "Active",
          "ClientId": "string",
          "ClientName": "string",
          "Description": "string",
          "Environment": "string",
          "OrganisationId": "string",
          "SoftwareStatementId": "string",
          "Mode": "Live",
          "RtsClientCreated": true,
          "OnBehalfOf": "string",
          "PolicyUri": "string",
          "ClientUri": "string",
          "LogoUri": "http://example.com",
          "RedirectUri": [
            "http://example.com"
          ],
          "TermsOfServiceUri": "http://example.com",
          "Version": 0,
          "Locked": true
        },
        "SoftwareAuthorityClaims": [
          {
            "SoftwareStatementId": "string",
            "SoftwareAuthorityClaimId": "string",
            "Status": "Active",
            "AuthorisationDomain": "string",
            "Role": "string"
          }
        ],
        "SoftwareCertificates": [
          {
            "OrganisationId": "string",
            "SoftwareStatementIds": [
              "string"
            ],
            "ClientName": "string",
            "Status": "string",
            "ValidFromDateTime": "string",
            "ExpiryDateTime": "string",
            "e": "string",
            "keyType": "string",
            "kid": "string",
            "kty": "string",
            "n": "string",
            "use": "string",
            "x5c": [
              "string"
            ],
            "x5t": "string",
            "x5thashS256": "string",
            "x5u": "string",
            "SignedCertPath": "string",
            "JwkPath": "string",
            "OrgJwkPath": "string"
          }
        ]
      }
    }
  }
}

Properties

Name Type Required Restrictions Description
additionalProperties OrganisationSnapshot false none none

OrganisationSnapshot

{
  "OrganisationDetails": {
    "OrganisationId": "string",
    "Status": "Active",
    "OrganisationName": "string",
    "CreatedOn": "string",
    "LegalEntityName": "string",
    "CountryOfRegistration": "string",
    "CompanyRegister": "string",
    "RegistrationNumber": "string",
    "RegistrationId": "string",
    "RegisteredName": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Postcode": "string",
    "Country": "string",
    "ParentOrganisationReference": "string",
    "RequiresSigning": true,
    "TnCUpdated": true,
    "TnCsToBeSigned": [
      {
        "TnCId": 0,
        "Version": 0,
        "Name": "string",
        "Type": "string",
        "Content": "string",
        "Status": "Active",
        "ExternalSigningService": {
          "ExternalSigningServiceName": "DocuSign",
          "ExternalSigningServiceSignerTemplateConfig": {
            "TemplateIdSigner1": "string",
            "TemplateIdSigner2": "string",
            "TemplateIdSigner3": "string",
            "TemplateIdSigner4": "string",
            "TemplateIdSigner5": "string",
            "TemplateIdSigner6": "string"
          },
          "ExternalSigningServiceSubject": "string"
        }
      }
    ]
  },
  "Contacts": [
    {
      "ContactId": "string",
      "OrganisationId": "string",
      "ContactType": "Business",
      "FirstName": "string",
      "LastName": "string",
      "Department": "string",
      "EmailAddress": "string",
      "PhoneNumber": "string",
      "AddressLine1": "string",
      "AddressLine2": "string",
      "City": "string",
      "Postcode": "string",
      "Country": "string",
      "AdditionalInformation": "string",
      "PgpPublicKey": "string"
    }
  ],
  "AuthorisationServers": [
    {
      "AuthorisationServerId": "string",
      "OrganisationId": "string",
      "AutoRegistrationSupported": true,
      "ApiResources": [
        {
          "ApiResourceId": "string",
          "ApiFamilyType": "string",
          "ApiVersion": 0,
          "ApiDiscoveryEndpoints": [
            {
              "ApiDiscoveryId": "string",
              "ApiEndpoint": "http://example.com"
            }
          ]
        }
      ],
      "CustomerFriendlyDescription": "string",
      "CustomerFriendlyLogoUri": "http://example.com",
      "CustomerFriendlyName": "string",
      "DeveloperPortalUri": "http://example.com",
      "TermsOfServiceUri": "http://example.com",
      "NotificationWebhook": "http://example.com",
      "NotificationWebhookStatus": "string",
      "OpenIDDiscoveryDocument": "http://example.com",
      "PayloadSigningCertLocationUri": "http://example.com",
      "ParentAuthorisationServerId": "string"
    }
  ],
  "OrgDomainClaims": [
    {
      "OrganisationAuthorityDomainClaimId": "string",
      "AuthorisationDomainName": "string",
      "AuthorityId": "string",
      "AuthorityName": "string",
      "RegistrationId": "string",
      "Status": "Active"
    }
  ],
  "OrgDomainRoleClaims": [
    {
      "OrganisationId": "string",
      "OrganisationAuthorityClaimId": "string",
      "AuthorityId": "string",
      "Status": "Active",
      "AuthorisationDomain": "string",
      "Role": "string",
      "Authorisations": [
        {
          "Status": "Active",
          "MemberState": "st"
        }
      ],
      "RegistrationId": "string",
      "UniqueTechnicalIdenifier": [
        "string"
      ]
    }
  ],
  "SoftwareStatements": {
    "property1": {
      "SoftwareDetails": {
        "Status": "Active",
        "ClientId": "string",
        "ClientName": "string",
        "Description": "string",
        "Environment": "string",
        "OrganisationId": "string",
        "SoftwareStatementId": "string",
        "Mode": "Live",
        "RtsClientCreated": true,
        "OnBehalfOf": "string",
        "PolicyUri": "string",
        "ClientUri": "string",
        "LogoUri": "http://example.com",
        "RedirectUri": [
          "http://example.com"
        ],
        "TermsOfServiceUri": "http://example.com",
        "Version": 0,
        "Locked": true
      },
      "SoftwareAuthorityClaims": [
        {
          "SoftwareStatementId": "string",
          "SoftwareAuthorityClaimId": "string",
          "Status": "Active",
          "AuthorisationDomain": "string",
          "Role": "string"
        }
      ],
      "SoftwareCertificates": [
        {
          "OrganisationId": "string",
          "SoftwareStatementIds": [
            "string"
          ],
          "ClientName": "string",
          "Status": "string",
          "ValidFromDateTime": "string",
          "ExpiryDateTime": "string",
          "e": "string",
          "keyType": "string",
          "kid": "string",
          "kty": "string",
          "n": "string",
          "use": "string",
          "x5c": [
            "string"
          ],
          "x5t": "string",
          "x5thashS256": "string",
          "x5u": "string",
          "SignedCertPath": "string",
          "JwkPath": "string",
          "OrgJwkPath": "string"
        }
      ]
    },
    "property2": {
      "SoftwareDetails": {
        "Status": "Active",
        "ClientId": "string",
        "ClientName": "string",
        "Description": "string",
        "Environment": "string",
        "OrganisationId": "string",
        "SoftwareStatementId": "string",
        "Mode": "Live",
        "RtsClientCreated": true,
        "OnBehalfOf": "string",
        "PolicyUri": "string",
        "ClientUri": "string",
        "LogoUri": "http://example.com",
        "RedirectUri": [
          "http://example.com"
        ],
        "TermsOfServiceUri": "http://example.com",
        "Version": 0,
        "Locked": true
      },
      "SoftwareAuthorityClaims": [
        {
          "SoftwareStatementId": "string",
          "SoftwareAuthorityClaimId": "string",
          "Status": "Active",
          "AuthorisationDomain": "string",
          "Role": "string"
        }
      ],
      "SoftwareCertificates": [
        {
          "OrganisationId": "string",
          "SoftwareStatementIds": [
            "string"
          ],
          "ClientName": "string",
          "Status": "string",
          "ValidFromDateTime": "string",
          "ExpiryDateTime": "string",
          "e": "string",
          "keyType": "string",
          "kid": "string",
          "kty": "string",
          "n": "string",
          "use": "string",
          "x5c": [
            "string"
          ],
          "x5t": "string",
          "x5thashS256": "string",
          "x5u": "string",
          "SignedCertPath": "string",
          "JwkPath": "string",
          "OrgJwkPath": "string"
        }
      ]
    }
  }
}

Properties

Name Type Required Restrictions Description
OrganisationDetails Organisation false none none
Contacts Contacts false none The list of contacts
AuthorisationServers AuthorisationServers false none none
OrgDomainClaims OrganisationAuthorityDomainClaims false none none
OrgDomainRoleClaims OrganisationAuthorityClaims false none none
SoftwareStatements object false none none
» additionalProperties object false none none
»» SoftwareDetails SoftwareStatement false none none
»» SoftwareAuthorityClaims SoftwareAuthorityClaims false none none
»» SoftwareCertificates CertificatesOrKeys false none none

OrganisationsExportOpenData

[
  {
    "OrganisationId": "string",
    "Status": "Active",
    "OrganisationName": "string",
    "CreatedOn": "string",
    "LegalEntityName": "string",
    "CountryOfRegistration": "string",
    "CompanyRegister": "string",
    "RegistrationNumber": "string",
    "RegistrationId": "string",
    "RegisteredName": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Postcode": "string",
    "Country": "string",
    "ParentOrganisationReference": "string",
    "Contacts": [
      {
        "ContactId": "string",
        "OrganisationId": "string",
        "ContactType": "Business",
        "FirstName": "string",
        "LastName": "string",
        "Department": "string",
        "EmailAddress": "string",
        "PhoneNumber": "string",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Postcode": "string",
        "Country": "string",
        "AdditionalInformation": "string",
        "PgpPublicKey": "string"
      }
    ],
    "AuthorisationServers": [
      {
        "AuthorisationServerId": "string",
        "OrganisationId": "string",
        "AutoRegistrationSupported": true,
        "ApiResources": [
          {
            "ApiResourceId": "string",
            "ApiFamilyType": "string",
            "ApiVersion": 0,
            "ApiDiscoveryEndpoints": [
              {
                "ApiDiscoveryId": "string",
                "ApiEndpoint": "http://example.com"
              }
            ]
          }
        ],
        "CustomerFriendlyDescription": "string",
        "CustomerFriendlyLogoUri": "http://example.com",
        "CustomerFriendlyName": "string",
        "DeveloperPortalUri": "http://example.com",
        "TermsOfServiceUri": "http://example.com",
        "NotificationWebhook": "http://example.com",
        "NotificationWebhookStatus": "string",
        "OpenIDDiscoveryDocument": "http://example.com",
        "PayloadSigningCertLocationUri": "http://example.com",
        "ParentAuthorisationServerId": "string"
      }
    ],
    "OrgDomainClaims": [
      {
        "OrganisationAuthorityDomainClaimId": "string",
        "AuthorisationDomainName": "string",
        "AuthorityId": "string",
        "AuthorityName": "string",
        "RegistrationId": "string",
        "Status": "Active"
      }
    ],
    "OrgDomainRoleClaims": [
      {
        "OrganisationId": "string",
        "OrganisationAuthorityClaimId": "string",
        "AuthorityId": "string",
        "Status": "Active",
        "AuthorisationDomain": "string",
        "Role": "string",
        "Authorisations": [
          {
            "Status": "Active",
            "MemberState": "st"
          }
        ],
        "RegistrationId": "string",
        "UniqueTechnicalIdenifier": [
          "string"
        ]
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
anonymous [OrganisationExportOpenData] false none none

OrganisationExportOpenData

{
  "OrganisationId": "string",
  "Status": "Active",
  "OrganisationName": "string",
  "CreatedOn": "string",
  "LegalEntityName": "string",
  "CountryOfRegistration": "string",
  "CompanyRegister": "string",
  "RegistrationNumber": "string",
  "RegistrationId": "string",
  "RegisteredName": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Postcode": "string",
  "Country": "string",
  "ParentOrganisationReference": "string",
  "Contacts": [
    {
      "ContactId": "string",
      "OrganisationId": "string",
      "ContactType": "Business",
      "FirstName": "string",
      "LastName": "string",
      "Department": "string",
      "EmailAddress": "string",
      "PhoneNumber": "string",
      "AddressLine1": "string",
      "AddressLine2": "string",
      "City": "string",
      "Postcode": "string",
      "Country": "string",
      "AdditionalInformation": "string",
      "PgpPublicKey": "string"
    }
  ],
  "AuthorisationServers": [
    {
      "AuthorisationServerId": "string",
      "OrganisationId": "string",
      "AutoRegistrationSupported": true,
      "ApiResources": [
        {
          "ApiResourceId": "string",
          "ApiFamilyType": "string",
          "ApiVersion": 0,
          "ApiDiscoveryEndpoints": [
            {
              "ApiDiscoveryId": "string",
              "ApiEndpoint": "http://example.com"
            }
          ]
        }
      ],
      "CustomerFriendlyDescription": "string",
      "CustomerFriendlyLogoUri": "http://example.com",
      "CustomerFriendlyName": "string",
      "DeveloperPortalUri": "http://example.com",
      "TermsOfServiceUri": "http://example.com",
      "NotificationWebhook": "http://example.com",
      "NotificationWebhookStatus": "string",
      "OpenIDDiscoveryDocument": "http://example.com",
      "PayloadSigningCertLocationUri": "http://example.com",
      "ParentAuthorisationServerId": "string"
    }
  ],
  "OrgDomainClaims": [
    {
      "OrganisationAuthorityDomainClaimId": "string",
      "AuthorisationDomainName": "string",
      "AuthorityId": "string",
      "AuthorityName": "string",
      "RegistrationId": "string",
      "Status": "Active"
    }
  ],
  "OrgDomainRoleClaims": [
    {
      "OrganisationId": "string",
      "OrganisationAuthorityClaimId": "string",
      "AuthorityId": "string",
      "Status": "Active",
      "AuthorisationDomain": "string",
      "Role": "string",
      "Authorisations": [
        {
          "Status": "Active",
          "MemberState": "st"
        }
      ],
      "RegistrationId": "string",
      "UniqueTechnicalIdenifier": [
        "string"
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
OrganisationId OrganisationId false none Unique ID associated with the organisation
Status string false none Status of the directory registration of an organisation
OrganisationName string false none Name of the organisation.
CreatedOn string false none JSONDatetime of organisation creation.
LegalEntityName string false none Legal Entity name for the org. Usually the same as org name
CountryOfRegistration string false none Country of registration for the org
CompanyRegister string false none Legal company register for the country, i.e. Companies House
RegistrationNumber string false none Company registration number from company register i.e. Companies House registration number
RegistrationId string false none Registered ID for the organisation i.e. Legal Entity identifier number
RegisteredName string false none none
AddressLine1 string false none Address line 1
AddressLine2 string false none Address line 2
City string false none City
Postcode string false none Postcode
Country string false none Country
ParentOrganisationReference string false none Parent Organisation Reference
Contacts Contacts false none The list of contacts
AuthorisationServers AuthorisationServers false none none
OrgDomainClaims OrganisationAuthorityDomainClaims false none none
OrgDomainRoleClaims OrganisationAuthorityClaims false none none

Enumerated Values

Property Value
Status Active
Status Pending
Status Withdrawn

Authorities

[
  {
    "AuthorityId": "string",
    "AuthorityName": "string",
    "AuthorityCode": "string",
    "AuthorityUri": "string",
    "AuthorityCountry": "string",
    "Status": "Active"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [Authority] false none none

Authority

{
  "AuthorityId": "string",
  "AuthorityName": "string",
  "AuthorityCode": "string",
  "AuthorityUri": "string",
  "AuthorityCountry": "string",
  "Status": "Active"
}

Properties

Name Type Required Restrictions Description
AuthorityId AuthorityId false none Unique ID associated with the Authorisation reference schema
AuthorityName string false none Name of the Authority i.e. FCA, etc
AuthorityCode string false none Code of the Authority i.e. FCA, etc
AuthorityUri string false none URI of the authority
AuthorityCountry string false none country of the Authority
Status string false none Is this Authority Active/Inactive

Enumerated Values

Property Value
Status Active
Status Inactive

AuthorityRequest

{
  "AuthorityName": "string",
  "AuthorityCode": "string",
  "AuthorityUri": "string",
  "AuthorityCountry": "string"
}

Properties

Name Type Required Restrictions Description
AuthorityName string true none The ID of the Authority i.e GBFCA, etc
AuthorityCode string true none Code of the Authority i.e. GBFCA, etc
AuthorityUri string true none URI of the authority
AuthorityCountry string true none Country of the authority

SoftwareStatementCertificateOrKeyType

"rtstransport"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous rtstransport
anonymous rtssigning
anonymous sigkey
anonymous enckey

SoftwareStatements

[
  {
    "Status": "Active",
    "ClientId": "string",
    "ClientName": "string",
    "Description": "string",
    "Environment": "string",
    "OrganisationId": "string",
    "SoftwareStatementId": "string",
    "Mode": "Live",
    "RtsClientCreated": true,
    "OnBehalfOf": "string",
    "PolicyUri": "string",
    "ClientUri": "string",
    "LogoUri": "http://example.com",
    "RedirectUri": [
      "http://example.com"
    ],
    "TermsOfServiceUri": "http://example.com",
    "Version": 0,
    "Locked": true
  }
]

The list of Software Statements

Properties

Name Type Required Restrictions Description
anonymous [SoftwareStatement] false none The list of Software Statements

SoftwareStatement

{
  "Status": "Active",
  "ClientId": "string",
  "ClientName": "string",
  "Description": "string",
  "Environment": "string",
  "OrganisationId": "string",
  "SoftwareStatementId": "string",
  "Mode": "Live",
  "RtsClientCreated": true,
  "OnBehalfOf": "string",
  "PolicyUri": "string",
  "ClientUri": "string",
  "LogoUri": "http://example.com",
  "RedirectUri": [
    "http://example.com"
  ],
  "TermsOfServiceUri": "http://example.com",
  "Version": 0,
  "Locked": true
}

Properties

Name Type Required Restrictions Description
Status string false none Is this software statement Active/Inactive
ClientId string false none Software Statement client Id
ClientName string false none Software Statement client name
Description string false none Software Statement description
Environment string false none The additional check for software statement, this field can avoid
OrganisationId OrganisationId false none Unique ID associated with the organisation
SoftwareStatementId SoftwareStatementId false none Unique Software Statement Id
Mode string false none Software Statement mode
RtsClientCreated boolean false none Client created flag
OnBehalfOf string false none A reference to fourth party organisation resource on the RTS Directory if the registering Org is acting on behalf of another
PolicyUri string false none The Software Statement policy compliant URI
ClientUri string false none The Software Statement client compliant URI
LogoUri string(uri) false none The Software Statement logo compliant URI
RedirectUri [string] false none The Software Statement redirect compliant URI
TermsOfServiceUri string(uri) false none The Software Statement terms of service compliant URI
Version number false none Software Statement version as provided by the organisation's PTC
Locked boolean false none Flag shows if assertion has been generated on the software statement - will be set to true when assertion is generated

Enumerated Values

Property Value
Status Active
Status Inactive
Mode Live
Mode Test

SoftwareStatementRequest

{
  "ClientName": "string",
  "Description": "string",
  "OnBehalfOf": "string",
  "PolicyUri": "string",
  "ClientUri": "string",
  "LogoUri": "string",
  "Environment": "string",
  "Mode": "Live",
  "RedirectUri": [
    "string"
  ],
  "TermsOfServiceUri": "string",
  "Version": 1
}

Properties

Name Type Required Restrictions Description
ClientName string true none Software Statement client name
Description string false none Software Statement description
OnBehalfOf string false none A reference to fourth party organisation resource on the RTS Directory if the registering Org is acting on behalf of another
PolicyUri string true none The Software Statement compliant policy URI
ClientUri string true none The Software Statement compliant client URI
LogoUri string true none The Software Statement compliant logo URI
Environment string false none The additional check for software statement, this field can avoid environment checks.
Mode string false none The additional check to see if the environment reflected above is live or test.
RedirectUri [string] true none The Software Statement redirect URIs
TermsOfServiceUri string true none The Software Statement terms of service compliant URI
Version number true none Software Statement version as provided by the organisation's PTC

Enumerated Values

Property Value
Mode Live
Mode Test

SoftwareStatementId

"string"

Unique Software Statement Id

Properties

Name Type Required Restrictions Description
anonymous string false none Unique Software Statement Id

SoftwareStatementAssertion

"string"

A signed JWT (JWS)

Properties

Name Type Required Restrictions Description
anonymous string false none A signed JWT (JWS)

SoftwareAuthorityClaims

[
  {
    "SoftwareStatementId": "string",
    "SoftwareAuthorityClaimId": "string",
    "Status": "Active",
    "AuthorisationDomain": "string",
    "Role": "string"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [SoftwareAuthorityClaim] false none none

SoftwareAuthorityClaim

{
  "SoftwareStatementId": "string",
  "SoftwareAuthorityClaimId": "string",
  "Status": "Active",
  "AuthorisationDomain": "string",
  "Role": "string"
}

Properties

Name Type Required Restrictions Description
SoftwareStatementId SoftwareStatementId false none Unique Software Statement Id
SoftwareAuthorityClaimId SoftwareAuthorityClaimId false none Unique ID associated with the authority claims for a software statement
Status string false none Is this authority claim Active/Inactive
AuthorisationDomain string false none Authorisation domain for the authority
Role string false none Roles for the Authority i.e. ASPSP, AISP, PISP, CBPII

Enumerated Values

Property Value
Status Active
Status Inactive

SoftwareAuthorityClaimRequest

{
  "Status": "Active",
  "AuthorisationDomain": "string",
  "Role": "string"
}

Properties

Name Type Required Restrictions Description
Status string true none Is this authority claim Active/Inactive, default is active
AuthorisationDomain string true none Authorisation domain for the authority
Role string true none Roles for the Authority i.e. ASPSP, AISP, PISP, CBPII

Enumerated Values

Property Value
Status Active
Status Inactive

SoftwareAuthorityClaimUpdateRequest

{
  "Status": "Active"
}

Properties

Name Type Required Restrictions Description
Status string true none This is used to set the status - Active/Inactive

Enumerated Values

Property Value
Status Active
Status Inactive

ClientCreationRequest

{
  "id_token_signed_response_alg": "PS256",
  "token_endpoint_auth_method": "private_key_jwt",
  "jwks_uri": "string",
  "tls_client_auth_subject_dn": "string",
  "redirect_uris": [
    "string"
  ],
  "response_types": [
    "string"
  ],
  "grant_types": [
    "string"
  ],
  "scope": "string"
}

Properties

Name Type Required Restrictions Description
id_token_signed_response_alg string true none Signing algorithim that a client expects the server to return an id_token with. Must be PS256
token_endpoint_auth_method string true none Token endpoint authentication method
jwks_uri string true none Link to the application active jwks
tls_client_auth_subject_dn string false none The DN of the certificate that will be used to authenticate to this client
redirect_uris [string] true none redirect_uris uri must be provided. For client_credentials this should be an empty array.
response_types [string] true none response_types uri must be provided. For client_credentials this should be an empty array
grant_types [string] true none grant_types uri must be provided. For client_credentials this should be array containing ["client_credentials"]
scope string true none scopes to be tagged

Enumerated Values

Property Value
id_token_signed_response_alg PS256
token_endpoint_auth_method private_key_jwt
token_endpoint_auth_method tls_client_auth
token_endpoint_auth_method client_secret_basic

ClientCreationResponse

{
  "application_type": "web",
  "tls_client_auth_subject_dn": "string",
  "grant_types": [
    "string"
  ],
  "id_token_signed_response_alg": "string",
  "require_auth_time": true,
  "subject_type": "string",
  "response_types": [
    "string"
  ],
  "post_logout_redirect_uris": [
    "string"
  ],
  "token_endpoint_auth_method": "string",
  "introspection_endpoint_auth_method": "string",
  "revocation_endpoint_auth_method": "string",
  "client_id_issued_at": 0,
  "client_id": "string",
  "jwks_uri": "string",
  "registration_client_uri": "string",
  "registration_access_token": "string",
  "redirect_uris": [
    "string"
  ],
  "request_uris": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
application_type string false none OIDC application type response
tls_client_auth_subject_dn string false none the subject dn used to authenticate this client
grant_types [string] false none grant_types
id_token_signed_response_alg string false none none
require_auth_time boolean false none none
subject_type string false none none
response_types [string] false none response_types
post_logout_redirect_uris [string] false none post_logout_redirect_uris
token_endpoint_auth_method string false none none
introspection_endpoint_auth_method string false none none
revocation_endpoint_auth_method string false none none
client_id_issued_at number false none none
client_id string false none none
jwks_uri string false none none
registration_client_uri string false none management uri location to manage client post creation
registration_access_token string false none token used to manage client post creation
redirect_uris [string] false none redirect_uris
request_uris [string] false none request_uris

Enumerated Values

Property Value
application_type web

AccessTokenRequest

{
  "grant_type": "client_credentials",
  "client_assertion_type": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
  "assertion": "string"
}

Properties

Name Type Required Restrictions Description
grant_type string true none The Grant Type
client_assertion_type string true none Restrict to private_key_jwt
assertion string true none The assertion that is used to get a token

Enumerated Values

Property Value
grant_type client_credentials
client_assertion_type urn:ietf:params:oauth:client-assertion-type:jwt-bearer

AccessTokenResponse

{
  "access_token": "string",
  "expires_in": 0,
  "token_type": "string",
  "scope": "string"
}

Properties

Name Type Required Restrictions Description
access_token string false none Access token
expires_in integer false none lifetime in seconds
token_type string false none none
scope string false none none

UserEmailId

"string"

User email address

Properties

Name Type Required Restrictions Description
anonymous string false none User email address

SuperUserCreationRequest

{
  "Email": "string"
}

Properties

Name Type Required Restrictions Description
Email string true none The super user email address

SuperUsers

[
  {
    "Email": "string",
    "Status": "Active"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [SuperUser] false none none

SuperUser

{
  "Email": "string",
  "Status": "Active"
}

Properties

Name Type Required Restrictions Description
Email string false none The super user email address
Status string false none Is this super user Active or Inactive

Enumerated Values

Property Value
Status Active
Status Inactive

AuthorisationDomainName

"string"

Authorisation Domain Name

Properties

Name Type Required Restrictions Description
anonymous string false none Authorisation Domain Name

AuthorisationDomainRoleName

"string"

Authorisation Domain Role Name

Properties

Name Type Required Restrictions Description
anonymous string false none Authorisation Domain Role Name

AuthorityAuthorisationDomainId

"string"

Mapping ID between Authority and Authorisation Domain

Properties

Name Type Required Restrictions Description
anonymous string false none Mapping ID between Authority and Authorisation Domain

AuthorisationDomainUserCreateRequest

{
  "Email": "string",
  "AuthorisationDomainRole": "string",
  "ContactRole": "PTC"
}

Properties

Name Type Required Restrictions Description
Email string true none The user email address
AuthorisationDomainRole string true none The authorisation domain role for this user
ContactRole ContactRoleEnum true none The role of the contact

AuthorisationDomainUsers

[
  {
    "AuthorisationDomainUserId": "string",
    "Email": "string",
    "AuthorisationDomain": "string",
    "AuthorisationDomainRole": "string",
    "Status": "Active",
    "ContactRole": "PTC"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [AuthorisationDomainUser] false none none

AuthorisationDomainUser

{
  "AuthorisationDomainUserId": "string",
  "Email": "string",
  "AuthorisationDomain": "string",
  "AuthorisationDomainRole": "string",
  "Status": "Active",
  "ContactRole": "PTC"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainUserId string false none Unique record ID
Email string false none The user email address
AuthorisationDomain string false none The authorisation domain for this user
AuthorisationDomainRole string false none The authorisation domain role for this user
Status string false none Is this user Active or Inactive
ContactRole string false none Type of role for this user

Enumerated Values

Property Value
Status Active
Status Inactive
ContactRole PTC
ContactRole STC
ContactRole PBC
ContactRole SBC

AuthorisationDomainRequest

{
  "AuthorisationDomainName": "string",
  "AuthorisationDomainRegion": "string",
  "AuthorisationDomainDescription": "string"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainName string true none The authorisation domain name
AuthorisationDomainRegion string true none The authorisation domain region
AuthorisationDomainDescription string false none The authorisation domain description

AuthorisationDomains

[
  {
    "AuthorisationDomainName": "string",
    "AuthorisationDomainRegion": "string",
    "AuthorisationDomainDescription": "string",
    "Status": "Active"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [AuthorisationDomain] false none none

AuthorisationDomain

{
  "AuthorisationDomainName": "string",
  "AuthorisationDomainRegion": "string",
  "AuthorisationDomainDescription": "string",
  "Status": "Active"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainName string false none The authorisation domain name
AuthorisationDomainRegion string false none The authorisation domain region
AuthorisationDomainDescription string false none The authorisation domain description
Status string false none Is this Domain Active or Inactive

Enumerated Values

Property Value
Status Active
Status Inactive

AuthorisationDomainRoleRequest

{
  "AuthorisationDomainName": "string",
  "AuthorisationDomainRoleName": "string",
  "AuthorisationDomainRoleDescription": "string"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainName string true none The authorisation domain name
AuthorisationDomainRoleName string true none The authorisation domain role name
AuthorisationDomainRoleDescription string false none The authorisation domain role description

AuthorisationDomainRoles

[
  {
    "AuthorisationDomainName": "string",
    "AuthorisationDomainRoleName": "string",
    "AuthorisationDomainRoleDescription": "string",
    "Status": "Active"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [AuthorisationDomainRole] false none none

AuthorisationDomainRole

{
  "AuthorisationDomainName": "string",
  "AuthorisationDomainRoleName": "string",
  "AuthorisationDomainRoleDescription": "string",
  "Status": "Active"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainName string false none The authorisation domain name
AuthorisationDomainRoleName string false none The authorisation domain role
AuthorisationDomainRoleDescription string false none The authorisation domain role description
Status string false none Is this mapping Active or Inactive

Enumerated Values

Property Value
Status Active
Status Inactive

AuthorityAuthorisationDomainRequest

{
  "AuthorisationDomainName": "string"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainName string true none The authorisation domain name

AuthorityAuthorisationDomains

[
  {
    "AuthorisationDomainName": "string",
    "AuthorityId": "string",
    "AuthorityAuthorisationDomainId": "string",
    "Status": "Active"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [AuthorityAuthorisationDomain] false none none

AuthorityAuthorisationDomain

{
  "AuthorisationDomainName": "string",
  "AuthorityId": "string",
  "AuthorityAuthorisationDomainId": "string",
  "Status": "Active"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainName string false none The authorisation domain name
AuthorityId string false none The GUID of the Authority
AuthorityAuthorisationDomainId string false none The GUID of the Authority-Domain mapping
Status string false none Is this user Active or Inactive

Enumerated Values

Property Value
Status Active
Status Inactive

OrganisationAuthorityDomainClaimId

"string"

Organisation Authority Domain Claim ID

Properties

Name Type Required Restrictions Description
anonymous string false none Organisation Authority Domain Claim ID

OrganisationAuthorityDomainClaimRequest

{
  "AuthorisationDomainName": "string",
  "AuthorityId": "string",
  "RegistrationId": "string"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainName string true none The authorisation domain name
AuthorityId string true none The Authority ID
RegistrationId string false none The registration ID

OrganisationAuthorityDomainClaims

[
  {
    "OrganisationAuthorityDomainClaimId": "string",
    "AuthorisationDomainName": "string",
    "AuthorityId": "string",
    "AuthorityName": "string",
    "RegistrationId": "string",
    "Status": "Active"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [OrganisationAuthorityDomainClaim] false none none

OrganisationAuthorityDomainClaim

{
  "OrganisationAuthorityDomainClaimId": "string",
  "AuthorisationDomainName": "string",
  "AuthorityId": "string",
  "AuthorityName": "string",
  "RegistrationId": "string",
  "Status": "Active"
}

Properties

Name Type Required Restrictions Description
OrganisationAuthorityDomainClaimId string false none The unique org authority domain claim ID
AuthorisationDomainName string false none The authorisation domain name
AuthorityId string false none The GUID of the Authority
AuthorityName string false none The name of the Authority
RegistrationId string false none The registration ID
Status string false none Is this user Active or Inactive

Enumerated Values

Property Value
Status Active
Status Inactive

AuthorisationDomainUserId

"string"

Unique record ID to identify Domain user

Properties

Name Type Required Restrictions Description
anonymous string false none Unique record ID to identify Domain user

UserDetail

{
  "SuperUser": true,
  "SystemUser": true,
  "BasicInformation": {
    "UserEmail": "string",
    "Status": "Active"
  },
  "OrgAccessDetails": {
    "property1": {
      "OrgAdmin": true,
      "DomainRoleDetails": [
        {
          "AuthorisationDomainName": "string",
          "AuthorisationDomainRoleName": "string",
          "Status": "Active",
          "ContactRole": "PTC"
        }
      ]
    },
    "property2": {
      "OrgAdmin": true,
      "DomainRoleDetails": [
        {
          "AuthorisationDomainName": "string",
          "AuthorisationDomainRoleName": "string",
          "Status": "Active",
          "ContactRole": "PTC"
        }
      ]
    }
  },
  "DirectoryTermsAndConditionsDetails": {
    "RequiresSigning": true,
    "Updated": true,
    "TermsAndConditionsItem": {
      "TnCId": 0,
      "Version": 0,
      "Name": "string",
      "Type": "string",
      "Content": "string",
      "Status": "Active",
      "ExternalSigningService": {
        "ExternalSigningServiceName": "DocuSign",
        "ExternalSigningServiceSignerTemplateConfig": {
          "TemplateIdSigner1": "string",
          "TemplateIdSigner2": "string",
          "TemplateIdSigner3": "string",
          "TemplateIdSigner4": "string",
          "TemplateIdSigner5": "string",
          "TemplateIdSigner6": "string"
        },
        "ExternalSigningServiceSubject": "string"
      }
    }
  }
}

Properties

Name Type Required Restrictions Description
SuperUser boolean false none Is the user a super user
SystemUser boolean false none Is the user a system user
BasicInformation object false none none
» UserEmail string false none none
» Status string false none none
OrgAccessDetails object false none Map Key - Org ID, Map Value - Org Access Detail(contaning info about org admin and domain role details)
» additionalProperties OrgAccessDetail false none none
DirectoryTermsAndConditionsDetails TermsAndConditionsDetails false none Details of TnC

Enumerated Values

Property Value
Status Active
Status Inactive

TermsAndConditionsDetails

{
  "RequiresSigning": true,
  "Updated": true,
  "TermsAndConditionsItem": {
    "TnCId": 0,
    "Version": 0,
    "Name": "string",
    "Type": "string",
    "Content": "string",
    "Status": "Active",
    "ExternalSigningService": {
      "ExternalSigningServiceName": "DocuSign",
      "ExternalSigningServiceSignerTemplateConfig": {
        "TemplateIdSigner1": "string",
        "TemplateIdSigner2": "string",
        "TemplateIdSigner3": "string",
        "TemplateIdSigner4": "string",
        "TemplateIdSigner5": "string",
        "TemplateIdSigner6": "string"
      },
      "ExternalSigningServiceSubject": "string"
    }
  }
}

Details of TnC

Properties

Name Type Required Restrictions Description
RequiresSigning boolean false none Does the Directory TnC require signing
Updated boolean false none Has the document updated since the user signed
TermsAndConditionsItem TermsAndConditionsItem false none none

UserCreateRequest

{
  "UserEmail": "string",
  "TermsAndConditionsId": 0
}

Properties

Name Type Required Restrictions Description
UserEmail string true none User's email
TermsAndConditionsId integer true none Id of the TnC(type = Directory), user has agreed to

UserOPInfo

{
  "sub": "string",
  "family_name": "string",
  "given_name": "string",
  "name": "string",
  "email": "string",
  "email_verified": true,
  "address": "string",
  "phone_number": "string",
  "phone_number_verified": true
}

The information contained within is subject to the scopes passed during token generation

Properties

Name Type Required Restrictions Description
sub string false none Contains the email address
family_name string false none Family name
given_name string false none Given name
name string false none Full name
email string false none Email address
email_verified boolean false none Is the email verified
address string false none Address
phone_number string false none Phone number
phone_number_verified boolean false none Is the phone number verified

WellKnown

{
  "acr_values_supported": [
    null
  ],
  "authorization_endpoint": "string",
  "claims_parameter_supported": true,
  "claims_supported": [
    null
  ],
  "code_challenge_methods_supported": [
    null
  ],
  "end_session_endpoint": "string",
  "check_session_endpoint": "string",
  "grant_types_supported": [
    null
  ],
  "id_token_signing_alg_values_supported": [
    null
  ],
  "issuer": "string",
  "jwks_uri": "string",
  "registration_endpoint": "string",
  "request_object_signing_alg_values_supported": "string",
  "request_parameter_supported": true,
  "request_uri_parameter_supported": true,
  "require_request_uri_registration": true,
  "pushed_authorization_request_endpoint": [
    null
  ],
  "response_modes_supported": [
    null
  ],
  "response_types_supported": [
    null
  ],
  "scopes_supported": [
    null
  ],
  "subject_types_supported": [
    null
  ],
  "token_endpoint_auth_methods_supported": [
    null
  ],
  "token_endpoint_auth_signing_alg_values_supported": [
    null
  ],
  "token_endpoint": "string",
  "userinfo_endpoint": "string",
  "userinfo_signing_alg_values_supported": [
    null
  ],
  "authorization_signing_alg_values_supported": [
    null
  ],
  "introspection_endpoint": "string",
  "introspection_endpoint_auth_methods_supported": [
    null
  ],
  "introspection_endpoint_auth_signing_alg_values_supported": [
    null
  ],
  "revocation_endpoint": "string",
  "revocation_endpoint_auth_methods_supported": [
    null
  ],
  "revocation_endpoint_auth_signing_alg_values_supported": [
    null
  ],
  "frontchannel_logout_supported": true,
  "frontchannel_logout_session_supported": true,
  "tls_client_certificate_bound_access_tokens": true,
  "claim_types_supported": [
    null
  ]
}

Properties

Name Type Required Restrictions Description
acr_values_supported [any] false none none
authorization_endpoint string false none REQUIRED. URL of the OP's OAuth 2.0 Authorization Endpoint
claims_parameter_supported boolean false none OPTIONAL. Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. If omitted, the default value is false
claims_supported [any] false none RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for
code_challenge_methods_supported [any] false none none
end_session_endpoint string false none none
check_session_endpoint string false none none
grant_types_supported [any] false none OPTIONAL. JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports
id_token_signing_alg_values_supported [any] false none REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT
issuer string false none REQUIRED. URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier
jwks_uri string false none REQUIRED. URL of the OP's JSON Web Key Set [JWK] document.
registration_endpoint string false none RECOMMENDED. URL of the OP's Dynamic Client Registration Endpoint
request_object_signing_alg_values_supported string false none OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects
request_parameter_supported boolean false none OPTIONAL. Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. If omitted, the default value is false
request_uri_parameter_supported boolean false none OPTIONAL. Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. If omitted, the default value is true
require_request_uri_registration boolean false none OPTIONAL. Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter
pushed_authorization_request_endpoint [any] false none none
response_modes_supported [any] false none OPTIONAL. JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports
response_types_supported [any] false none REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this OP supports
scopes_supported [any] false none RECOMMENDED. JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports
subject_types_supported [any] false none REQUIRED. JSON array containing a list of the Subject Identifier types that this OP supports
token_endpoint_auth_methods_supported [any] false none OPTIONAL. JSON array containing a list of Client Authentication methods supported by this Token Endpoint
token_endpoint_auth_signing_alg_values_supported [any] false none OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the JWT
token_endpoint string false none URL of the OP's OAuth 2.0 Token Endpoint
userinfo_endpoint string false none RECOMMENDED. URL of the OP's UserInfo Endpoint
userinfo_signing_alg_values_supported [any] false none OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT
authorization_signing_alg_values_supported [any] false none none
introspection_endpoint string false none none
introspection_endpoint_auth_methods_supported [any] false none none
introspection_endpoint_auth_signing_alg_values_supported [any] false none none
revocation_endpoint string false none none
revocation_endpoint_auth_methods_supported [any] false none none
revocation_endpoint_auth_signing_alg_values_supported [any] false none none
frontchannel_logout_supported boolean false none none
frontchannel_logout_session_supported boolean false none none
tls_client_certificate_bound_access_tokens boolean false none none
claim_types_supported [any] false none OPTIONAL. JSON array containing a list of the Claim Types that the OpenID Provider supports

OrgAccessDetail

{
  "OrgAdmin": true,
  "DomainRoleDetails": [
    {
      "AuthorisationDomainName": "string",
      "AuthorisationDomainRoleName": "string",
      "Status": "Active",
      "ContactRole": "PTC"
    }
  ]
}

Properties

Name Type Required Restrictions Description
OrgAdmin boolean false none Is the user the org admin of the current org
DomainRoleDetails [DomainRoleDetail] false none Array of domain, role and status of domain role mapping

DomainRoleDetail

{
  "AuthorisationDomainName": "string",
  "AuthorisationDomainRoleName": "string",
  "Status": "Active",
  "ContactRole": "PTC"
}

Properties

Name Type Required Restrictions Description
AuthorisationDomainName string false none none
AuthorisationDomainRoleName string false none none
Status StatusEnum false none none
ContactRole ContactRoleEnum false none The role of the contact

TnCId

0

TnC unique identifier

Properties

Name Type Required Restrictions Description
anonymous integer false none TnC unique identifier

ClientId

"string"

The ClientID

Properties

Name Type Required Restrictions Description
anonymous string false none The ClientID

TermsAndConditionsPage

{
  "totalPages": 0,
  "totalSize": 0,
  "pageable": {
    "number": 0,
    "sort": {
      "sorted": true,
      "orderBy": [
        {
          "property": "createdAt",
          "direction": "ASC",
          "ignoreCase": true,
          "ascending": true
        }
      ]
    },
    "size": 0,
    "offset": 0,
    "sorted": true
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "TnCId": 0,
      "Version": 0,
      "Name": "string",
      "Type": "string",
      "Content": "string",
      "Status": "Active",
      "ExternalSigningService": {
        "ExternalSigningServiceName": "DocuSign",
        "ExternalSigningServiceSignerTemplateConfig": {
          "TemplateIdSigner1": "string",
          "TemplateIdSigner2": "string",
          "TemplateIdSigner3": "string",
          "TemplateIdSigner4": "string",
          "TemplateIdSigner5": "string",
          "TemplateIdSigner6": "string"
        },
        "ExternalSigningServiceSubject": "string"
      }
    }
  ],
  "offset": 0,
  "empty": true,
  "pageNumber": 0
}

Properties

Name Type Required Restrictions Description
totalPages integer false none none
totalSize integer false none none
pageable Pageable false none none
numberOfElements integer false none none
size integer false none none
content [TermsAndConditionsItem] false none none
offset integer false none none
empty boolean false none none
pageNumber integer false none none

TermsAndConditionsItem

{
  "TnCId": 0,
  "Version": 0,
  "Name": "string",
  "Type": "string",
  "Content": "string",
  "Status": "Active",
  "ExternalSigningService": {
    "ExternalSigningServiceName": "DocuSign",
    "ExternalSigningServiceSignerTemplateConfig": {
      "TemplateIdSigner1": "string",
      "TemplateIdSigner2": "string",
      "TemplateIdSigner3": "string",
      "TemplateIdSigner4": "string",
      "TemplateIdSigner5": "string",
      "TemplateIdSigner6": "string"
    },
    "ExternalSigningServiceSubject": "string"
  }
}

Properties

Name Type Required Restrictions Description
TnCId integer false none Unique identifier for the Terms and Conditions Item
Version integer false none none
Name string false none none
Type string false none Identifies Participant or Directory
Content string false none Contains the MarkDown of the actual TnCs
Status string false none Is the TnC Active or Inactive
ExternalSigningService object false none none
» ExternalSigningServiceName string false none none
» ExternalSigningServiceSignerTemplateConfig ExternalSigningServiceSignerTemplateConfig false none none
» ExternalSigningServiceSubject string false none none

Enumerated Values

Property Value
Status Active
Status Inactive
ExternalSigningServiceName DocuSign

TermsAndConditionsCreateRequest

{
  "Type": "Participant",
  "Version": 0,
  "Name": "string",
  "Content": "string",
  "ExternalSigningServiceName": "DocuSign",
  "ExternalSigningServiceSignerTemplateConfig": {
    "TemplateIdSigner1": "string",
    "TemplateIdSigner2": "string",
    "TemplateIdSigner3": "string",
    "TemplateIdSigner4": "string",
    "TemplateIdSigner5": "string",
    "TemplateIdSigner6": "string"
  },
  "ExternalSigningServiceSubject": "string"
}

Properties

Name Type Required Restrictions Description
Type string true none Role for which this TnC applies
Version integer true none Version of the TnC document
Name string true none The Name of the TnC
Content string true none The MarkDown of the TnC
ExternalSigningServiceName string false none The Name of the External Signing Service
ExternalSigningServiceSignerTemplateConfig ExternalSigningServiceSignerTemplateConfig false none none
ExternalSigningServiceSubject string false none The Subject of the External Signing Service

Enumerated Values

Property Value
Type Participant
Type Directory
ExternalSigningServiceName DocuSign

ExternalSigningServiceSignerTemplateConfig

{
  "TemplateIdSigner1": "string",
  "TemplateIdSigner2": "string",
  "TemplateIdSigner3": "string",
  "TemplateIdSigner4": "string",
  "TemplateIdSigner5": "string",
  "TemplateIdSigner6": "string"
}

Properties

Name Type Required Restrictions Description
TemplateIdSigner1 string false none Template ID for 1 signer
TemplateIdSigner2 string false none Template ID for 2 signers
TemplateIdSigner3 string false none Template ID for 3 signers
TemplateIdSigner4 string false none Template ID for 4 signers
TemplateIdSigner5 string false none Template ID for 5 signers
TemplateIdSigner6 string false none Template ID for 6 signers

TermsAndConditionsUpdateRequest

{
  "Content": "string",
  "ExternalSigningServiceName": "DocuSign",
  "ExternalSigningServiceSignerTemplateConfig": {
    "TemplateIdSigner1": "string",
    "TemplateIdSigner2": "string",
    "TemplateIdSigner3": "string",
    "TemplateIdSigner4": "string",
    "TemplateIdSigner5": "string",
    "TemplateIdSigner6": "string"
  },
  "ExternalSigningServiceSubject": "string"
}

Properties

Name Type Required Restrictions Description
Content string true none The MarkDown of the TnC
ExternalSigningServiceName string false none The Name of the External Signing Service
ExternalSigningServiceSignerTemplateConfig ExternalSigningServiceSignerTemplateConfig false none none
ExternalSigningServiceSubject string false none The Subject of the External Signing Service

Enumerated Values

Property Value
ExternalSigningServiceName DocuSign

OrgAdminUserCreateRequest

{
  "UserEmail": "string"
}

Properties

Name Type Required Restrictions Description
UserEmail string true none Admin user email address

OrganisationAdminUsers

[
  {
    "Status": "Active",
    "UserEmail": "string",
    "DomainRoleDetails": [
      {
        "AuthorisationDomainName": "string",
        "AuthorisationDomainRoleName": "string",
        "Status": "Active",
        "ContactRole": "PTC"
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
anonymous [OrganisationAdminUser] false none none

OrganisationAdminUser

{
  "Status": "Active",
  "UserEmail": "string",
  "DomainRoleDetails": [
    {
      "AuthorisationDomainName": "string",
      "AuthorisationDomainRoleName": "string",
      "Status": "Active",
      "ContactRole": "PTC"
    }
  ]
}

Properties

Name Type Required Restrictions Description
Status string false none Is the admin user active
UserEmail string false none Users email address
DomainRoleDetails [DomainRoleDetail] false none none

Enumerated Values

Property Value
Status Active
Status Inactive

ApiResources

{
  "totalPages": 0,
  "totalSize": 0,
  "pageable": {
    "number": 0,
    "sort": {
      "sorted": true,
      "orderBy": [
        {
          "property": "createdAt",
          "direction": "ASC",
          "ignoreCase": true,
          "ascending": true
        }
      ]
    },
    "size": 0,
    "offset": 0,
    "sorted": true
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "ApiResourceId": "string",
      "ApiFamilyType": "string",
      "ApiVersion": 0,
      "ApiDiscoveryEndpoints": [
        {
          "ApiDiscoveryId": "string",
          "ApiEndpoint": "http://example.com"
        }
      ]
    }
  ],
  "offset": 0,
  "empty": true,
  "pageNumber": 0
}

Properties

Name Type Required Restrictions Description
totalPages integer false none none
totalSize integer false none none
pageable Pageable false none none
numberOfElements integer false none none
size integer false none none
content [ApiResource] false none none
offset integer false none none
empty boolean false none none
pageNumber integer false none none

ApiResource

{
  "ApiResourceId": "string",
  "ApiFamilyType": "string",
  "ApiVersion": 0,
  "ApiDiscoveryEndpoints": [
    {
      "ApiDiscoveryId": "string",
      "ApiEndpoint": "http://example.com"
    }
  ]
}

Properties

Name Type Required Restrictions Description
ApiResourceId ApiResourceId false none The unique ID of an Api version resource
ApiFamilyType ApiFamilyType false none The type of API this record describes
ApiVersion number false none The version number of the API
ApiDiscoveryEndpoints [ApiDiscoveryEndpoint] false none none

ApiResourceRequest

{
  "ApiFamilyType": "string",
  "ApiVersion": 0
}

Properties

Name Type Required Restrictions Description
ApiFamilyType ApiFamilyType false none The type of API this record describes
ApiVersion number false none The version number of the API

ApiFamilyType

"string"

The type of API this record describes

Properties

Name Type Required Restrictions Description
anonymous string false none The type of API this record describes

ApiResourceId

"string"

The unique ID of an Api version resource

Properties

Name Type Required Restrictions Description
anonymous string false none The unique ID of an Api version resource

ApiDiscoveryEndpoints

{
  "totalPages": 0,
  "totalSize": 0,
  "pageable": {
    "number": 0,
    "sort": {
      "sorted": true,
      "orderBy": [
        {
          "property": "createdAt",
          "direction": "ASC",
          "ignoreCase": true,
          "ascending": true
        }
      ]
    },
    "size": 0,
    "offset": 0,
    "sorted": true
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "ApiDiscoveryId": "string",
      "ApiEndpoint": "http://example.com"
    }
  ],
  "offset": 0,
  "empty": true,
  "pageNumber": 0
}

Properties

Name Type Required Restrictions Description
totalPages integer false none none
totalSize integer false none none
pageable Pageable false none none
numberOfElements integer false none none
size integer false none none
content [ApiDiscoveryEndpoint] false none none
offset integer false none none
empty boolean false none none
pageNumber integer false none none

ApiDiscoveryEndpoint

{
  "ApiDiscoveryId": "string",
  "ApiEndpoint": "http://example.com"
}

Properties

Name Type Required Restrictions Description
ApiDiscoveryId string false none Unique Id of this discovery endpoint record
ApiEndpoint string(uri) false none A compliant URI

ApiDiscoveryEndpointRequest

{
  "ApiEndpoint": "http://example.com"
}

Properties

Name Type Required Restrictions Description
ApiEndpoint string(uri) false none A compliant URI

ApiDiscoveryEndpointId

"string"

The unique ID of an Api discovery endpoint resource

Properties

Name Type Required Restrictions Description
anonymous string false none The unique ID of an Api discovery endpoint resource

OrgTermsAndConditionsPage

{
  "totalPages": 0,
  "totalSize": 0,
  "pageable": {
    "number": 0,
    "sort": {
      "sorted": true,
      "orderBy": [
        {
          "property": "createdAt",
          "direction": "ASC",
          "ignoreCase": true,
          "ascending": true
        }
      ]
    },
    "size": 0,
    "offset": 0,
    "sorted": true
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "InitiatedBy": "string",
      "Role": "string",
      "TermsAndConditionsDetail": {
        "TermsAndConditionsItem": {
          "TnCId": 0,
          "Version": 0,
          "Name": "string",
          "Type": "string",
          "Content": "string",
          "Status": "Active",
          "ExternalSigningService": {
            "ExternalSigningServiceName": "DocuSign",
            "ExternalSigningServiceSignerTemplateConfig": {
              "TemplateIdSigner1": "string",
              "TemplateIdSigner2": "string",
              "TemplateIdSigner3": "string",
              "TemplateIdSigner4": "string",
              "TemplateIdSigner5": "string",
              "TemplateIdSigner6": "string"
            },
            "ExternalSigningServiceSubject": "string"
          }
        },
        "InititatedDate": "string",
        "ExternalSigningServiceEnvelopeId": "string",
        "ExternalSigningServiceEnvelopeStatus": "Completed",
        "ExternalSigningServiceEnvelopePasscode": "string"
      }
    }
  ],
  "offset": 0,
  "empty": true,
  "pageNumber": 0
}

Properties

Name Type Required Restrictions Description
totalPages integer false none none
totalSize integer false none none
pageable Pageable false none none
numberOfElements integer false none none
size integer false none none
content [OrgTermsAndConditionsDetail] false none [Participant TnC details]
offset integer false none none
empty boolean false none none
pageNumber integer false none none

UserTermsAndConditionsPage

{
  "totalPages": 0,
  "totalSize": 0,
  "pageable": {
    "number": 0,
    "sort": {
      "sorted": true,
      "orderBy": [
        {
          "property": "createdAt",
          "direction": "ASC",
          "ignoreCase": true,
          "ascending": true
        }
      ]
    },
    "size": 0,
    "offset": 0,
    "sorted": true
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "TermsAndConditionsItem": {
        "TnCId": 0,
        "Version": 0,
        "Name": "string",
        "Type": "string",
        "Content": "string",
        "Status": "Active",
        "ExternalSigningService": {
          "ExternalSigningServiceName": "DocuSign",
          "ExternalSigningServiceSignerTemplateConfig": {
            "TemplateIdSigner1": "string",
            "TemplateIdSigner2": "string",
            "TemplateIdSigner3": "string",
            "TemplateIdSigner4": "string",
            "TemplateIdSigner5": "string",
            "TemplateIdSigner6": "string"
          },
          "ExternalSigningServiceSubject": "string"
        }
      },
      "InititatedDate": "string",
      "ExternalSigningServiceEnvelopeId": "string",
      "ExternalSigningServiceEnvelopeStatus": "Completed",
      "ExternalSigningServiceEnvelopePasscode": "string"
    }
  ],
  "offset": 0,
  "empty": true,
  "pageNumber": 0
}

Properties

Name Type Required Restrictions Description
totalPages integer false none none
totalSize integer false none none
pageable Pageable false none none
numberOfElements integer false none none
size integer false none none
content [TermsAndConditionsDetail] false none [TnC details Parent]
offset integer false none none
empty boolean false none none
pageNumber integer false none none

EssSignRequest

{
  "TnCId": 0,
  "NoOfSigners": 0
}

Properties

Name Type Required Restrictions Description
TnCId TnCId false none TnC unique identifier
NoOfSigners integer false none none

EssPollResponse

{
  "ExternalSigningServiceEnvelopeStatus": "Completed"
}

Properties

Name Type Required Restrictions Description
ExternalSigningServiceEnvelopeStatus ExternalSigningServiceEnvelopeStatus false none none

TnCsToBeSigned

[
  {
    "TnCId": 0,
    "Version": 0,
    "Name": "string",
    "Type": "string",
    "Content": "string",
    "Status": "Active",
    "ExternalSigningService": {
      "ExternalSigningServiceName": "DocuSign",
      "ExternalSigningServiceSignerTemplateConfig": {
        "TemplateIdSigner1": "string",
        "TemplateIdSigner2": "string",
        "TemplateIdSigner3": "string",
        "TemplateIdSigner4": "string",
        "TemplateIdSigner5": "string",
        "TemplateIdSigner6": "string"
      },
      "ExternalSigningServiceSubject": "string"
    }
  }
]

Properties

Name Type Required Restrictions Description
anonymous [TermsAndConditionsItem] false none none

ExternalSigningServiceEnvelopeId

"string"

The envelope id of the ess signing request

Properties

Name Type Required Restrictions Description
anonymous string false none The envelope id of the ess signing request

AuthorisationDomainUserUpdateRequest

{
  "Status": "Active",
  "ContactRole": "PTC"
}

Properties

Name Type Required Restrictions Description
Status StatusEnum false none none
ContactRole ContactRoleEnum false none The role of the contact

ContactRoleEnum

"PTC"

The role of the contact

Properties

Name Type Required Restrictions Description
anonymous string false none The role of the contact

Enumerated Values

Property Value
anonymous PTC
anonymous STC
anonymous PBC
anonymous SBC

Service Desk

Especificações de APIs do Service Desk

O Service Desk do Open Insurance Brasil pode ser acessado tanto via interface gráfica quanto por meio sistêmico através de APIs.

Para acessar a documentação das APIs do Service Desk é necessário logar na ferramenta via interface gráfica, acessar a sessão de FAQ e selecionar o menu "API SysAid".

As funcionalidades previamente liberadas para acesso são:

Como documento adicional, é possível fazer o download de um PDF nesse link (Especificação APIs Service Desk) contendo todas as informações listadas no repositório acima.

Monitoramento

As APIs de Status, de Outages e Métricas são comuns a todos os participantes do Open Insurance Brasil, independentemente da fase de adesão. Portanto, todas as instituições devem publicar essas APIs que monitoram a situação do ambiente. Reforçamos ainda que na API de métricas devem ser reportados os dados de performance de todas demais APIs que a instituição desenvolveu.

APIs - Comuns

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

As APIs descritas neste documento são referentes as APIs da fase Open Data do Open Insurance Brasil.

Base URLs:

Web: Support

Especificação em OAS
Detalhamento Técnico

status v1.0.0

A descrição referente ao código de status retornado pelas APIs

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/discovery/v1/status");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/discovery/v1/status", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/discovery/v1/status")
  .header("Accept", "application/json")
  .asString();

GET /status

Descrição referente ao código de status retornado pelas APIs

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada, sendo a primeira página 1.
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "status": [
      {
        "code": "OK",
        "explanation": "Retorno com Sucesso",
        "detectionTime": "2021-07-21T08:30:00Z",
        "expectedResolutionTime": "2021-07-21T08:30:00Z",
        "updateTime": "2021-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
  },
  "meta": {
    "totalRecords": 9,
    "totalPages": 3
  }
}

Responses

Status Meaning Description Schema
200 OK Código de status retornado pelas APIs ResponseDiscoveryStatusList

outages v1.0.0

a descrição referente a listagem de indisponibilidades agendadas para os serviços

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/discovery/v1/outages");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/discovery/v1/outages", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/discovery/v1/outages")
  .header("Accept", "application/json")
  .asString();

GET /outages

a descrição referente a listagem de indisponibilidades agendadas para os serviços

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada, sendo a primeira página 1.
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": [
    {
      "outageTime": "2020-07-21T08:30:00Z",
      "duration": "PT2H30M",
      "isPartial": false,
      "explanation": "Atualização do API Gateway",
      "unavailableEndpoints": [
        "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
      ]
    }
  ],
  "links": {
    "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
  },
  "meta": {
    "totalRecords": 9,
    "totalPages": 3
  }
}

Responses

Status Meaning Description Schema
200 OK listagem de indisponibilidades agendadas para os serviços ResponseDiscoveryOutageList

Schemas

ResponseDiscoveryStatusList

{
  "data": {
    "status": [
      {
        "code": "OK",
        "explanation": "Retorno com Sucesso",
        "detectionTime": "2021-07-21T08:30:00Z",
        "expectedResolutionTime": "2021-07-21T08:30:00Z",
        "updateTime": "2021-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
  },
  "meta": {
    "totalRecords": 9,
    "totalPages": 3
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» status [Status] true none none
links Links true none none
meta Meta true none none

ResponseDiscoveryOutageList

{
  "data": [
    {
      "outageTime": "2020-07-21T08:30:00Z",
      "duration": "PT2H30M",
      "isPartial": false,
      "explanation": "Atualização do API Gateway",
      "unavailableEndpoints": [
        "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
      ]
    }
  ],
  "links": {
    "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
  },
  "meta": {
    "totalRecords": 9,
    "totalPages": 3
  }
}

Properties

Name Type Required Restrictions Description
data [any] true none none
» outageTime string true none Data e hora planejada do início da indisponibilidade
» duration string true none Duração prevista da indisponibilidade
» isPartial boolean true none Flag que indica se a indisponibilidade é parcial (atingindo apenas alguns end points) ou total (atingindo todos os end points)
» explanation string true none Explicação sobre os motivos da indisponibilidade.
» unavailableEndpoints [string] true none Endpoints com indisponibilidade.
links Links true none none
meta Meta true none none

{
  "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
  "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
  "prev": "string",
  "next": "string",
  "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

Meta

{
  "totalRecords": 9,
  "totalPages": 3
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

Status

{
  "code": "OK",
  "explanation": "Retorno com Sucesso",
  "detectionTime": "2021-07-21T08:30:00Z",
  "expectedResolutionTime": "2021-07-21T08:30:00Z",
  "updateTime": "2021-01-02T01:00:00Z",
  "unavailableEndpoints": [
    "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
  ]
}

Properties

Name Type Required Restrictions Description
code string true none Condição atual da API:
* OK - A implementação é totalmente funcional
* PARTIAL_FAILURE - Um ou mais endpoints estão indisponíveis
* UNAVAILABLE - A implementação completa está indisponível
* SCHEDULED_OUTAGE - Uma interrupção anunciada está em vigor
explanation string true none Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK
detectionTime string false none A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE
expectedResolutionTime string false none A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK
updateTime string false none A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.
unavailableEndpoints [string] false none Endpoints com indisponibilidade

Enumerated Values

Property Value
code OK
code PARTIAL_FAILURE
code UNAVAILABLE
code SCHEDULED_OUTAGE

API - Admin

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

As APIs administrativas são recursos que podem ser consumidos apenas pelo diretório para avaliação e controle da qualidade dos serviços fornecidos pelas instituições

Base URLs:

Web: Support

Especificação em OAS
Detalhamento Técnico

admin v1.1.0

Obtém as métricas de disponibilidade das APIs

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.organizacao.com.br/open-insurance/admin/v1/metrics");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/admin/v1/metrics", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("http://api.organizacao.com.br/open-insurance/admin/v1/metrics")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /metrics

Obtém as métricas de disponibilidade das APIs

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.
period query string false Período a ser consultado

Detailed descriptions

period: Período a ser consultado * CURRENT - Métricas do dia atual. * ALL - Métricas de todo o período disponível.

Enumerated Values

Parameter Value
period CURRENT
period ALL

Example responses

200 Response

{
  "data": {
    "requestTime": "2019-08-24T14:15:22Z",
    "availability": {
      "uptime": {
        "generalUptimeRate": "string",
        "endpoints": [
          {
            "url": "string",
            "uptimeRate": "string"
          }
        ]
      },
      "downtime": {
        "generalDowntime": 0,
        "scheduledOutage": 0,
        "endpoints": [
          {
            "url": "string",
            "partialDowntime": 0
          }
        ]
      }
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "peakTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "errors": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "rejections": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
    "first": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados das métricas ResponseMetricsList

Schemas

ResponseMetricsList

{
  "data": {
    "requestTime": "2019-08-24T14:15:22Z",
    "availability": {
      "uptime": {
        "generalUptimeRate": "string",
        "endpoints": [
          {
            "url": "string",
            "uptimeRate": "string"
          }
        ]
      },
      "downtime": {
        "generalDowntime": 0,
        "scheduledOutage": 0,
        "endpoints": [
          {
            "url": "string",
            "partialDowntime": 0
          }
        ]
      }
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "peakTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "errors": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "rejections": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
    "first": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» requestTime string(date-time) true none Data e hora que as métricas foram requisitadas.
» availability AvailabilityMetrics true none none
» invocations InvocationMetrics true none none
» averageResponse AverageMetrics true none none
» averageTps AverageTPSMetrics true none none
» peakTps PeakTPSMetrics true none none
» errors ErrorMetrics true none none
» rejections RejectionMetrics true none none
links Links true none none
meta Meta false none none

AvailabilityMetrics

{
  "uptime": {
    "generalUptimeRate": "string",
    "endpoints": [
      {
        "url": "string",
        "uptimeRate": "string"
      }
    ]
  },
  "downtime": {
    "generalDowntime": 0,
    "scheduledOutage": 0,
    "endpoints": [
      {
        "url": "string",
        "partialDowntime": 0
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
uptime object true none none
» generalUptimeRate string true none Taxa de disponibilidade (considerando todos os serviços ativos ao mesmo tempo).
» endpoints EndpointUptime true none none
downtime object true none none
» generalDowntime integer true none Quantidade de segundos de downtime (considerando qualquer api em downtime).
» scheduledOutage integer true none Quantidade de segundos de indisponibilidade agendada.
» endpoints EndpointDowntime true none none

EndpointUptime

[
  {
    "url": "string",
    "uptimeRate": "string"
  }
]

Properties

Name Type Required Restrictions Description
url string true none URL do endpoint
uptimeRate string true none Taxa de disponibilidade do endpoint.

EndpointDowntime

[
  {
    "url": "string",
    "partialDowntime": 0
  }
]

Properties

Name Type Required Restrictions Description
url string true none URL do endpoint
partialDowntime integer true none Quantidade de segundos de indisponibilidade do endpoint.

InvocationMetrics

{
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "highPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "mediumPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unattended": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

Properties

Name Type Required Restrictions Description
unauthenticated object true none Número de chamadas não autenticadas.
» currentDay integer true none Número de chamadas não autenticadas no dia atual.
» previousDays [integer] true none Número de chamadas não autenticadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
highPriority object true none Número de chamadas para o nível de alta prioridade.
» currentDay integer true none Número de chamadas no dia atual para o nível de alta prioridade.
» previousDays [integer] true none Número de chamadas nos dias anteriores para o nível de alta prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
mediumPriority object true none Número de chamadas para o nível de média prioridade.
» currentDay integer true none Número de chamadas no dia atual para o nível de média prioridade.
» previousDays [integer] true none Número de chamadas nos dias anteriores para o nível de média prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
unattended object true none Número de chamadas para o nível não acompanhado.
» currentDay integer true none Número de chamadas no dia atual para o nível não acompanhado.
» previousDays [integer] true none Número de chamadas nos dias anteriores para o nível não acompanhado. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

AverageMetrics

{
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "highPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "mediumPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unattended": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

Properties

Name Type Required Restrictions Description
unauthenticated object true none Tempo médio de resposta para chamadas não autenticadas.
» currentDay integer true none Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays [integer] true none Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
highPriority object true none Tempo médio de resposta de chamadas para o nível de alta prioridade.
» currentDay integer true none Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays [integer] true none Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
mediumPriority object true none Tempo médio de resposta para chamadas para o nível de média prioridade.
» currentDay integer true none Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays [integer] true none Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
unattended object true none Tempo médio de resposta para chamadas para o nível não acompanhado.
» currentDay integer true none Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays [integer] true none Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

AverageTPSMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
currentDay integer true none Número médio de chamadas por segundo no dia.
previousDays [integer] true none Número médio de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

PeakTPSMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
currentDay integer true none Pico de chamadas por segundo no dia.
previousDays [integer] true none Pico de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

ErrorMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
currentDay integer true none Número de chamadas com erro no dia atual.
previousDays [integer] true none Número de chamadas com erro nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

RejectionMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
currentDay integer true none Número de chamadas rejeitadas no dia atual.
previousDays [integer] true none Número de chamadas rejeitadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

{
  "self": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
  "first": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
  "prev": "string",
  "next": "string",
  "last": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

Meta

{
  "totalRecords": 1,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

Fase 1 - APIs do Open Insurance Brasil

Estas APIs disponíveis visam exibir e compartilhar dados não sensíveis de instituições participantes do OpenInsurance Brasil, disponibilizando ao público informações sobre os seus canais de atendimento e as características de produtos e serviços tradicionais de seguro que oferecem.

API - Canais de Atendimento

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

As APIs descritas neste documento são referentes as APIs da fase Open Data do Open Insurance Brasil.

Base URLs:

Web: Support

Especificação em OAS

branches v1.0.0

Obtém a listagem de dependências próprias da instituição.

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.organizacao.com.br/open-insurance/channels/v1/branches");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/channels/v1/branches", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("http://api.organizacao.com.br/open-insurance/channels/v1/branches")
  .header("Accept", "application/json")
  .asString();

GET /branches

Método para obter a listagem de dependências próprias da instituição.

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "Organização AZ",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "branches": [
            {
              "identification": {
                "type": "POSTO_ATENDIMENTO",
                "code": 1,
                "checkDigit": 9,
                "name": "Marília"
              },
              "postalAddress": {
                "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
                "additionalInfo": "Loja B",
                "districtName": "Centro",
                "townName": "São Paulo",
                "ibgeCode": 3550308,
                "countrySubDivision": "SP",
                "postCode": "17500-001",
                "country": "Brasil",
                "countryCode": "BRA",
                "geographicCoordinates": {
                  "latitude": "-90.8365180",
                  "longitude": "-180.836519"
                }
              },
              "availability": {
                "standards": [
                  {
                    "weekday": "SEGUNDA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  }
                ],
                "isPublicAccessAllowed": true
              },
              "phones": [
                {
                  "type": "FIXO",
                  "countryCallingCode": "55",
                  "areaCode": "19",
                  "number": "35721199"
                }
              ],
              "services": [
                {
                  "name": "ENDOSSO",
                  "code": "PORTABILIDADE"
                }
              ]
            }
          ]
        }
      ]
    },
    "links": {
      "self": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
      "first": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
      "prev": "string",
      "next": "string",
      "last": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>"
    },
    "meta": {
      "totalRecords": 1,
      "totalPages": 1
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Lista de dependências próprias obtida com sucesso. ResponseBranchesList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default none None

electronic-channels v1.1.0

Obtém a listagem de canais eletrônicos de atendimento da instituição.

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/channels/v1/electronic-channels", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("http://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels")
  .header("Accept", "application/json")
  .asString();

GET /electronic-channels

Método para obter a listagem de canais eletrônicos de atendimento da instituição.

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-insurance",
          "electronicChannels": [
            {
              "identification": {
                "type": "INTERNET",
                "urls": [
                  "https://empresa1.com/insurance"
                ]
              },
              "services": [
                {
                  "name": "SEGUROS",
                  "code": "SEGUROS"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Listagem de canais eletrônicos de atendimento obtida com sucesso. ResponseElectronicChannelsList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default none None

intermediary v1.1.0

Obtem a lista dos produtos do tipo Intermediarios

Especificação em OAS
Detalhamento Técnico

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/channels/v1/intermediary/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/channels/v1/intermediary/string", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/channels/v1/intermediary/string")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /intermediary/{countrySubDivision}

Obtem a lista dos produtos do tipo Intermediarios

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.
countrySubDivision path string true Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado
line query string false Linha de negócio de atuação

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "ACME Group Seguros",
      "companies": [
        {
          "name": "ACME Seguros",
          "cnpjNumber": "12345678901234",
          "identification": [
            {
              "name": "Intermediário C",
              "nameOther": "Intermediário D",
              "documentNumber": 12341234123412,
              "type": "CORRETOR_DE_SEGUROS",
              "SUSEP": 15414622222222222,
              "postalAddress": [
                {
                  "address": "'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n",
                  "additionalInfo": "Loja B",
                  "districtName": "Paraíso",
                  "townName": "São Paulo",
                  "ibgeCode": "string",
                  "countrySubDivision": "AC",
                  "postCode": 1310200,
                  "country": "ANDORRA",
                  "countryCode": "BRA",
                  "geographicCoordinates": {
                    "latitude": -89.836518,
                    "longitude": -179.836519
                  }
                }
              ],
              "access": {
                "standards": [
                  {
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z",
                    "weekday": "DOMINGO"
                  }
                ],
                "email": "Joao.silva@seguradoraa.com.br",
                "site": "https://openinsurance.com.br/aaa",
                "phones": [
                  {
                    "type": "FIXO",
                    "countryCallingCode": 55,
                    "areaCode": 11,
                    "number": 30041000
                  }
                ]
              },
              "services": [
                {
                  "name": "ACONSELHAMENTO_SOBRE_PRODUTOS_OFERTADOS",
                  "nameOthers": "string",
                  "line": [
                    "CAPITALIZACAO"
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "prev": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "next": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados dos produtos de Intermediarios ResponseIntermediaryList
204 No Content O recurso solicitado não existe ou não foi localizado. ResponseError
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default Dados dos produtos de API de informações de dados do produto Intermediarios. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados. ResponseIntermediaryList

phone-channels v1.0.0

Obtém a listagem de canais telefônicos de atendimento da instituição.

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.organizacao.com.br/open-insurance/channels/v1/phone-channels");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/channels/v1/phone-channels", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("http://api.organizacao.com.br/open-insurance/channels/v1/phone-channels")
  .header("Accept", "application/json")
  .asString();

GET /phone-channels

Método para obter a listagem de canais telefônicos de atendimento da instituição.

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-insurance",
          "phoneChannels": [
            {
              "identification": {
                "type": "CENTRAL_TELEFONICA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "35721199"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "997865532"
                  }
                ]
              },
              "services": [
                {
                  "name": "ALTERACACOES_FORMA_PAGAMENTO",
                  "code": "01"
                },
                {
                  "name": "AVISO_SINISTRO",
                  "code": "02"
                },
                {
                  "name": "ENDOSSO",
                  "code": "05"
                }
              ]
            },
            {
              "identification": {
                "type": "SAC",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACAO",
                  "code": "16"
                },
                {
                  "name": "PORTABILIDADE",
                  "code": "15"
                },
                {
                  "name": "ENDOSSO",
                  "code": "05"
                }
              ]
            },
            {
              "identification": {
                "type": "OUVIDORIA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACAO",
                  "code": "16"
                },
                {
                  "name": "PORTABILIDADE",
                  "code": "15"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Listagem de canais telefônicos de atendimento obtida com sucesso. ResponsePhoneChannelsList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default none None

referenced-network v1.1.0

Obtem a lista dos produtos do tipo Rede Referenciada

Especificação em OAS
Detalhamento Técnico

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/channels/v1/referenced-network/string/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/channels/v1/referenced-network/string/string", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/channels/v1/referenced-network/string/string")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /referenced-network/{countrySubDivision}/{serviceType}

Obtem a lista dos produtos do tipo Rede Referenciada

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.
countrySubDivision path string true Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado
serviceType path string true Listagem de tipos que deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "ACME Group Seguros",
      "companies": [
        {
          "name": "ACME Seguros",
          "cnpjNumber": "12345678901234",
          "identification": [
            {
              "name": "Empresa B",
              "cnpjNumber": 12341234123412,
              "products": [
                {
                  "code": "01234589-0",
                  "name": "Produto de Seguro",
                  "coverage": [
                    "string"
                  ]
                }
              ],
              "postalAddress": [
                {
                  "address": "'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n",
                  "additionalInfo": "Loja B",
                  "districtName": "Paraíso",
                  "townName": "São Paulo",
                  "ibgeCode": "string",
                  "countrySubDivision": "AC",
                  "postCode": 1310200,
                  "country": "ANDORRA",
                  "countryCode": "BRA",
                  "geographicCoordinates": {
                    "latitude": -89.836518,
                    "longitude": -179.836519
                  }
                }
              ],
              "access": [
                {
                  "standards": [
                    {}
                  ],
                  "restrictionIndicator": false,
                  "phones": [
                    {}
                  ]
                }
              ],
              "services": [
                {
                  "type": "ASSISTENCIA_AUTO",
                  "typeOthers": "string",
                  "name": [
                    "ACIONAMENTO_E_OU_AGENDAMENTO_DE_LEVA_E_TRAZ"
                  ],
                  "description": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "prev": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "next": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados dos produtos de Rede Referenciada ResponseReferencedNetworkList
204 No Content O recurso solicitado não existe ou não foi localizado. ResponseError
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default Dados dos produtos de API de informações de dados do produto Rede Referenciada. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados. ResponseReferencedNetworkList

Schemas

ResponseBranchesList

{
  "data": {
    "brand": {
      "name": "Organização AZ",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "branches": [
            {
              "identification": {
                "type": "POSTO_ATENDIMENTO",
                "code": 1,
                "checkDigit": 9,
                "name": "Marília"
              },
              "postalAddress": {
                "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
                "additionalInfo": "Loja B",
                "districtName": "Centro",
                "townName": "São Paulo",
                "ibgeCode": 3550308,
                "countrySubDivision": "SP",
                "postCode": "17500-001",
                "country": "Brasil",
                "countryCode": "BRA",
                "geographicCoordinates": {
                  "latitude": "-90.8365180",
                  "longitude": "-180.836519"
                }
              },
              "availability": {
                "standards": [
                  {
                    "weekday": "SEGUNDA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  }
                ],
                "isPublicAccessAllowed": true
              },
              "phones": [
                {
                  "type": "FIXO",
                  "countryCallingCode": "55",
                  "areaCode": "19",
                  "number": "35721199"
                }
              ],
              "services": [
                {
                  "name": "ENDOSSO",
                  "code": "PORTABILIDADE"
                }
              ]
            }
          ]
        }
      ]
    },
    "links": {
      "self": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
      "first": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
      "prev": "string",
      "next": "string",
      "last": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>"
    },
    "meta": {
      "totalRecords": 1,
      "totalPages": 1
    }
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» brand BranchesBrand true none none
» links LinksPaginated false none none
» meta MetaPaginated false none none

BranchesBrand

{
  "name": "Organização AZ",
  "companies": [
    {
      "name": "Empresa A1",
      "cnpjNumber": "45086338000178",
      "branches": [
        {
          "identification": {
            "type": "POSTO_ATENDIMENTO",
            "code": 1,
            "checkDigit": 9,
            "name": "Marília"
          },
          "postalAddress": {
            "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
            "additionalInfo": "Loja B",
            "districtName": "Centro",
            "townName": "São Paulo",
            "ibgeCode": 3550308,
            "countrySubDivision": "SP",
            "postCode": "17500-001",
            "country": "Brasil",
            "countryCode": "BRA",
            "geographicCoordinates": {
              "latitude": "-90.8365180",
              "longitude": "-180.836519"
            }
          },
          "availability": {
            "standards": [
              {
                "weekday": "SEGUNDA_FEIRA",
                "openingTime": "10:00:57Z",
                "closingTime": "16:00:57Z"
              }
            ],
            "isPublicAccessAllowed": true
          },
          "phones": [
            {
              "type": "FIXO",
              "countryCallingCode": "55",
              "areaCode": "19",
              "number": "35721199"
            }
          ],
          "services": [
            {
              "name": "ENDOSSO",
              "code": "PORTABILIDADE"
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
companies [BranchesCompany] true none Companies traz uma lista de todas as instuituições da Marca.

BranchesCompany

{
  "name": "Empresa A1",
  "cnpjNumber": "45086338000178",
  "branches": [
    {
      "identification": {
        "type": "POSTO_ATENDIMENTO",
        "code": 1,
        "checkDigit": 9,
        "name": "Marília"
      },
      "postalAddress": {
        "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
        "additionalInfo": "Loja B",
        "districtName": "Centro",
        "townName": "São Paulo",
        "ibgeCode": 3550308,
        "countrySubDivision": "SP",
        "postCode": "17500-001",
        "country": "Brasil",
        "countryCode": "BRA",
        "geographicCoordinates": {
          "latitude": "-90.8365180",
          "longitude": "-180.836519"
        }
      },
      "availability": {
        "standards": [
          {
            "weekday": "SEGUNDA_FEIRA",
            "openingTime": "10:00:57Z",
            "closingTime": "16:00:57Z"
          }
        ],
        "isPublicAccessAllowed": true
      },
      "phones": [
        {
          "type": "FIXO",
          "countryCallingCode": "55",
          "areaCode": "19",
          "number": "35721199"
        }
      ],
      "services": [
        {
          "name": "ENDOSSO",
          "code": "PORTABILIDADE"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none none
cnpjNumber string true none Número completo do CNPJ da instituição responsável pela dependência - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
Deve-se ter apenas os números do CNPJ, sem máscara
branches [Branch] false none Lista de Dependências de uma Instituição

ResponseElectronicChannelsList

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-insurance",
          "electronicChannels": [
            {
              "identification": {
                "type": "INTERNET",
                "urls": [
                  "https://empresa1.com/insurance"
                ]
              },
              "services": [
                {
                  "name": "SEGUROS",
                  "code": "SEGUROS"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
brand ElectronicChannelsBrand false none none
links LinksPaginated true none none
meta MetaPaginated true none none

ElectronicChannelsBrand

{
  "name": "Marca A",
  "companies": [
    {
      "name": "Empresa da Marca A",
      "cnpjNumber": "string",
      "electronicChannels": [
        {
          "identification": {
            "type": "CHAT",
            "accessType": "EMAIL",
            "urls": [
              "string"
            ]
          },
          "services": [
            {
              "name": "ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA",
              "code": "RECLAMACAO"
            }
          ],
          "availability": {
            "standards": [
              {
                "weekday": "SEGUNDA_FEIRA",
                "openingTime": "10:00:57Z",
                "closingTime": "16:00:57Z"
              }
            ]
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da marca selecionada pela Organização proprietária da dependência (titular).
companies [ElectronicChannelsCompanies] true none Lista de instituições pertencentes à marca

ElectronicChannelsCompanies

{
  "name": "Empresa da Marca A",
  "cnpjNumber": "string",
  "electronicChannels": [
    {
      "identification": {
        "type": "CHAT",
        "accessType": "EMAIL",
        "urls": [
          "string"
        ]
      },
      "services": [
        {
          "name": "ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA",
          "code": "RECLAMACAO"
        }
      ],
      "availability": {
        "standards": [
          {
            "weekday": "SEGUNDA_FEIRA",
            "openingTime": "10:00:57Z",
            "closingTime": "16:00:57Z"
          }
        ]
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da marca selecionada pela Organização proprietária da dependência (titular).
cnpjNumber string true none CNPJ da sociedade responsável pelo canal de atendimento - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
electronicChannels [ElectronicChannels] true none Lista de canais de atendimento eltrônico

Branch

{
  "identification": {
    "type": "POSTO_ATENDIMENTO",
    "code": 1,
    "checkDigit": 9,
    "name": "Marília"
  },
  "postalAddress": {
    "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
    "additionalInfo": "Loja B",
    "districtName": "Centro",
    "townName": "São Paulo",
    "ibgeCode": 3550308,
    "countrySubDivision": "SP",
    "postCode": "17500-001",
    "country": "Brasil",
    "countryCode": "BRA",
    "geographicCoordinates": {
      "latitude": "-90.8365180",
      "longitude": "-180.836519"
    }
  },
  "availability": {
    "standards": [
      {
        "weekday": "SEGUNDA_FEIRA",
        "openingTime": "10:00:57Z",
        "closingTime": "16:00:57Z"
      }
    ],
    "isPublicAccessAllowed": true
  },
  "phones": [
    {
      "type": "FIXO",
      "countryCallingCode": "55",
      "areaCode": "19",
      "number": "35721199"
    }
  ],
  "services": [
    {
      "name": "ENDOSSO",
      "code": "PORTABILIDADE"
    }
  ]
}

Dependência destinada à prática das atividades para as quais a instituição esteja regularmente habilitada.

Properties

Name Type Required Restrictions Description
identification BranchIdentification false none none
postalAddress BranchPostalAddress true none none
availability BranchAvailability true none none
phones [BranchPhone] false none Listagem de telefones da Dependência própria
services [BranchService] true none Traz a relação de serviços disponbilizados pelo Canal de Atendimento

BranchPostalAddress

{
  "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
  "additionalInfo": "Loja B",
  "districtName": "Centro",
  "townName": "São Paulo",
  "ibgeCode": 3550308,
  "countrySubDivision": "SP",
  "postCode": "17500-001",
  "country": "Brasil",
  "countryCode": "BRA",
  "geographicCoordinates": {
    "latitude": "-90.8365180",
    "longitude": "-180.836519"
  }
}

Properties

Name Type Required Restrictions Description
address string true none Deverá trazer toda a informação referente ao endereço da dependência informada. Tipo de logradouro + Nome do logradouro + Número do Logradouro (se não existir usar ' s/n') + complemento (se houver).
additionalInfo string false none Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir.
districtName string true none Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas.
townName string true none O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado.
ibgeCode string true none Código IBGE de Município. A Tabela de Códigos de Municípios do IBGE apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação.
countrySubDivision string true none Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. São consideradas apenas as siglas para os estados brasileiros.
postCode string true none Código de Endereçamento Postal. Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios.
country string false none Nome do país.
countryCode string false none Código do país de acordo com o código “alpha3” do ISO-3166.
geographicCoordinates BranchesGeographicCoordinates false none Informação referente a geolocalização informada.

BranchIdentification

{
  "type": "POSTO_ATENDIMENTO",
  "code": 1,
  "checkDigit": 9,
  "name": "Marília"
}

Properties

Name Type Required Restrictions Description
type string false none Tipo de dependência.
code string false none Código identificador da dependência
checkDigit string false none Dígito verificador do código da dependência
name string false none Nome da dependência

Enumerated Values

Property Value
type POSTO_ATENDIMENTO
type UNIDADE_ADMINISTRATIVA_DESMEMBRADA

BranchAvailability

{
  "standards": [
    {
      "weekday": "SEGUNDA_FEIRA",
      "openingTime": "10:00:57Z",
      "closingTime": "16:00:57Z"
    }
  ],
  "isPublicAccessAllowed": true
}

Properties

Name Type Required Restrictions Description
standards [any] true none Lista disponibilidade padrão da depêndencia próprias por dias da semana
» weekday string true none Dia da semana de abertura da dependência
» openingTime string true none Horário de abertura da dependência (UTC)
» closingTime string true none Horário de fechamento da dependência (UTC)
isPublicAccessAllowed boolean false none Indica se a instalação da Dependência tem acesso restrito a clientes.

Enumerated Values

Property Value
weekday DOMINGO
weekday SEGUNDA_FEIRA
weekday TERCA_FEIRA
weekday QUARTA_FEIRA
weekday QUINTA_FEIRA
weekday SEXTA_FEIRA
weekday SABADO

EletronicChannelsAvailability

{
  "standards": [
    {
      "weekday": "SEGUNDA_FEIRA",
      "openingTime": "10:00:57Z",
      "closingTime": "16:00:57Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
standards [any] true none Lista disponibilidade padrão da depêndencia próprias por dias da semana
» weekday string true none Dias de funcionamento em formato texto
» openingTime string true none Horário padrão de início de atendimento do canal eletrônico. (UTC)
» closingTime string true none Horário padrão de encerramento de atendimento do canal eletrônico (UTC)

Enumerated Values

Property Value
weekday DOMINGO
weekday SEGUNDA_FEIRA
weekday TERCA_FEIRA
weekday QUARTA_FEIRA
weekday QUINTA_FEIRA
weekday SEXTA_FEIRA
weekday SABADO

PhoneChannelsAvailability

{
  "standards": [
    {
      "weekday": "SEGUNDA_FEIRA",
      "openingTime": "10:00:57Z",
      "closingTime": "16:00:57Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
standards [any] true none Lista disponibilidade padrão da depêndencia próprias por dias da semana
» weekday string true none Dia da semana de abertura da dependência
» openingTime string true none Horário de abertura da dependência (UTC)
» closingTime string true none Horário de fechamento da dependência (UTC)

Enumerated Values

Property Value
weekday DOMINGO
weekday SEGUNDA_FEIRA
weekday TERCA_FEIRA
weekday QUARTA_FEIRA
weekday QUINTA_FEIRA
weekday SEXTA_FEIRA
weekday SABADO

BranchService

{
  "name": "ENDOSSO",
  "code": "PORTABILIDADE"
}

Properties

Name Type Required Restrictions Description
name string true none Nome dos Serviços efetivamente prestados pelo Canal de Atendimento
code string true none Código dos Serviços efetivamente prestados pelo Canal de Atendimento

Enumerated Values

Property Value
name ALTERACOES_FORMA_PAGAMENTO
name AVISO_SINISTRO
name CANCELAMENTO_SUSPENSAO_PAGAMENTO_PREMIOS_CONTRIBUICAO
name EFETIVACAO_APORTE
name ENDOSSO
name ENVIO_DOCUMENTOS
name INFORMACOES_GERAIS_DUVIDAS
name INFORMACOES_INTERMEDIARIOS
name INFORMACOES_SOBRE_SERVICOS_ASSISTENCIAS
name INFORMACOES_SOBRE_SORTEIOS
name OUVIDORIA_RECEPCAO_SUGESTOES_ELOGIOS
name OUVIDORIA_SOLUCAO_EVENTUAIS_DIVERGENCIAS_SOBRE_CONTRATO_SEGURO_CAPITALIZAÇÃO_PREVIDÊNCIA_APOS_ESGOTADOS_CANAIS_REGULARES_ATENDIMENTO_AQUELAS_ORIUNDAS_ORGAOS_REGULADORES_OU_INTEGRANTES_SISTEMA_NACIONAL_DEFESA_CONSUMIDOR
name OUVIDORIA_TRATAMENTO_INSATISFACAO_CONSUMIDOR_RELACAO_ATENDIMENTO_RECEBIDO_CANAIS_REGULARES_ATENDIMENTO
name OUVIDORIA_TRATAMENTO_RECLAMACOES_SOBRE_IRREGULARDADES_CONDUTA_COMPANHIA
name PORTABILIDADE
name RECLAMACAO
name RESGATE
name SEGUNDA_VIA_DOCUMENTOS_CONTRATUAIS
name SUGESTOES_ELOGIOS
code 01
code 02
code 03
code 04
code 05
code 06
code 07
code 08
code 09
code 10
code 11
code 12
code 13
code 14
code 15
code 16
code 17
code 18
code 19

ElectronicChannels

{
  "identification": {
    "type": "CHAT",
    "accessType": "EMAIL",
    "urls": [
      "string"
    ]
  },
  "services": [
    {
      "name": "ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA",
      "code": "RECLAMACAO"
    }
  ],
  "availability": {
    "standards": [
      {
        "weekday": "SEGUNDA_FEIRA",
        "openingTime": "10:00:57Z",
        "closingTime": "16:00:57Z"
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
identification ElectronicChannelsIdentification true none none
services [ElectronicChannelsServices] true none Traz a relação de serviços disponbilizados pelo Canal de Atendimento
availability EletronicChannelsAvailability false none none

ElectronicChannelsIdentification

{
  "type": "CHAT",
  "accessType": "EMAIL",
  "urls": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
type string true none Tipo de canal de atendimento eletrônico
accessType string false none Tipo de acesso
urls [ElectronicChannelsUrl] true none Lista das URLs que atendem um tipo de canal eletrônico selecionado

Enumerated Values

Property Value
type INTERNET
type MOBILE
type CHAT
type WHATSAPP
type CONSUMIDOR
type OUTROS
accessType EMAIL
accessType INTERNET
accessType APP
accessType CHAT
accessType WHATSAPP
accessType CONSUMIDOR
accessType OUTROS

ElectronicChannelsUrl

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

ElectronicChannelsServices

{
  "name": "ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA",
  "code": "RECLAMACAO"
}

Properties

Name Type Required Restrictions Description
name string true none Nome dos Serviços efetivamente prestados pelo Canal de Atendimento
code string true none Código dos Serviços efetivamente prestados pelo Canal de Atendimento

Enumerated Values

Property Value
name ALTERACACOES_FORMA_PAGAMENTO
name AVISO_SINISTRO
name CANCELAMENTO_SUSPENSAO_PAGAMENTO_PREMIOS_CONTRIBUICAO
name EFETIVACAO_APORTE
name ENDOSSO
name ENVIO_DOCUMENTOS
name INFORMACOES_GERAIS_DUVIDAS
name INFORMACOES_INTERMEDIARIOS
name INFORMACOES_SOBRE_SERVICOS_ASSISTENCIAS
name INFORMACOES_SOBRE_SORTEIOS
name OUVIDORIA_RECEPCAO_SUGESTOES_ELOGIOS
name OUVIDORIA_SOLUCAO_EVENTUAIS_DIVERGENCIAS_SOBRE_CONTRATO_SEGURO_CAPITALIZAÇÃO_PREVIDÊNCIA_APOS_ESGOTADOS_CANAIS_REGULARES_ATENDIMENTO_AQUELAS_ORIUNDAS_ORGAOS_REGULADORES_OU_INTEGRANTES_SISTEMA_NACIONAL_DEFESA_CONSUMIDOR
name OUVIDORIA_TRATAMENTO_INSATISFACAO_CONSUMIDOR_RELACAO_ATENDIMENTO_RECEBIDO_CANAIS_REGULARES_ATENDIMENTO
name OUVIDORIA_TRATAMENTO_RECLAMACOES_SOBRE_IRREGULARDADES_CONDUTA_COMPANHIA
name PORTABILIDADE
name RECLAMACAO
name RESGATE
name SEGUNDA_VIA_DOCUMENTOS_CONTRATUAIS
name SUGESTOES_ELOGIOS
code 01
code 02
code 03
code 04
code 05
code 06
code 07
code 08
code 09
code 10
code 11
code 12
code 13
code 14
code 15
code 16
code 17
code 18
code 19

BranchPhone

{
  "type": "FIXO",
  "countryCallingCode": "55",
  "areaCode": "19",
  "number": "35721199"
}

Properties

Name Type Required Restrictions Description
type string false none Identificação do Tipo de telefone da dependência. p.ex.FIXO, MOVEL.
countryCallingCode string false none Número de DDI (Discagem Direta Internacional) para telefone de acesso ao Canal - se houver. p.ex. '55'
areaCode string false none Número de DDD (Discagem Direta à Distância) do telefone da dependência - se houver. p.ex. '19'
number string false none Número de telefone da dependência - se houver

Enumerated Values

Property Value
type FIXO
type MOVEL

ResponseIntermediaryList

{
  "data": {
    "brand": {
      "name": "ACME Group Seguros",
      "companies": [
        {
          "name": "ACME Seguros",
          "cnpjNumber": "12345678901234",
          "identification": [
            {
              "name": "Intermediário C",
              "nameOther": "Intermediário D",
              "documentNumber": 12341234123412,
              "type": "CORRETOR_DE_SEGUROS",
              "SUSEP": 15414622222222222,
              "postalAddress": [
                {
                  "address": "'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n",
                  "additionalInfo": "Loja B",
                  "districtName": "Paraíso",
                  "townName": "São Paulo",
                  "ibgeCode": "string",
                  "countrySubDivision": "AC",
                  "postCode": 1310200,
                  "country": "ANDORRA",
                  "countryCode": "BRA",
                  "geographicCoordinates": {
                    "latitude": -89.836518,
                    "longitude": -179.836519
                  }
                }
              ],
              "access": {
                "standards": [
                  {
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z",
                    "weekday": "DOMINGO"
                  }
                ],
                "email": "Joao.silva@seguradoraa.com.br",
                "site": "https://openinsurance.com.br/aaa",
                "phones": [
                  {
                    "type": "FIXO",
                    "countryCallingCode": 55,
                    "areaCode": 11,
                    "number": 30041000
                  }
                ]
              },
              "services": [
                {
                  "name": "ACONSELHAMENTO_SOBRE_PRODUTOS_OFERTADOS",
                  "nameOthers": "string",
                  "line": [
                    "CAPITALIZACAO"
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "prev": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "next": "https://api.organizacao.com.br/open-insurance/channels/v1",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» brand IntermediaryBrand true none Organizacao controladora do grupo.
links Links true none none
meta Meta true none none

IntermediaryBrand

{
  "name": "ACME Group Seguros",
  "companies": [
    {
      "name": "ACME Seguros",
      "cnpjNumber": "12345678901234",
      "identification": [
        {
          "name": "Intermediário C",
          "nameOther": "Intermediário D",
          "documentNumber": 12341234123412,
          "type": "CORRETOR_DE_SEGUROS",
          "SUSEP": 15414622222222222,
          "postalAddress": [
            {
              "address": "'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n",
              "additionalInfo": "Loja B",
              "districtName": "Paraíso",
              "townName": "São Paulo",
              "ibgeCode": "string",
              "countrySubDivision": "AC",
              "postCode": 1310200,
              "country": "ANDORRA",
              "countryCode": "BRA",
              "geographicCoordinates": {
                "latitude": -89.836518,
                "longitude": -179.836519
              }
            }
          ],
          "access": {
            "standards": [
              {
                "openingTime": "10:00:57Z",
                "closingTime": "16:00:57Z",
                "weekday": "DOMINGO"
              }
            ],
            "email": "Joao.silva@seguradoraa.com.br",
            "site": "https://openinsurance.com.br/aaa",
            "phones": [
              {
                "type": "FIXO",
                "countryCallingCode": 55,
                "areaCode": 11,
                "number": 30041000
              }
            ]
          },
          "services": [
            {
              "name": "ACONSELHAMENTO_SOBRE_PRODUTOS_OFERTADOS",
              "nameOthers": "string",
              "line": [
                "CAPITALIZACAO"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Organizacao controladora do grupo.

Properties

Name Type Required Restrictions Description
name string true none Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
companies IntermediaryCompany true none none

IntermediaryCompany

[
  {
    "name": "ACME Seguros",
    "cnpjNumber": "12345678901234",
    "identification": [
      {
        "name": "Intermediário C",
        "nameOther": "Intermediário D",
        "documentNumber": 12341234123412,
        "type": "CORRETOR_DE_SEGUROS",
        "SUSEP": 15414622222222222,
        "postalAddress": [
          {
            "address": "'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n",
            "additionalInfo": "Loja B",
            "districtName": "Paraíso",
            "townName": "São Paulo",
            "ibgeCode": "string",
            "countrySubDivision": "AC",
            "postCode": 1310200,
            "country": "ANDORRA",
            "countryCode": "BRA",
            "geographicCoordinates": {
              "latitude": -89.836518,
              "longitude": -179.836519
            }
          }
        ],
        "access": {
          "standards": [
            {
              "openingTime": "10:00:57Z",
              "closingTime": "16:00:57Z",
              "weekday": "DOMINGO"
            }
          ],
          "email": "Joao.silva@seguradoraa.com.br",
          "site": "https://openinsurance.com.br/aaa",
          "phones": [
            {
              "type": "FIXO",
              "countryCallingCode": 55,
              "areaCode": 11,
              "number": 30041000
            }
          ]
        },
        "services": [
          {
            "name": "ACONSELHAMENTO_SOBRE_PRODUTOS_OFERTADOS",
            "nameOthers": "string",
            "line": [
              "CAPITALIZACAO"
            ]
          }
        ]
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
name string true none Nome da sociedade supervisionada participante
cnpjNumber string true none CNPJ da sociedade supervisionada participante
identification IntermediaryIdentification true none none

IntermediaryIdentification

[
  {
    "name": "Intermediário C",
    "nameOther": "Intermediário D",
    "documentNumber": 12341234123412,
    "type": "CORRETOR_DE_SEGUROS",
    "SUSEP": 15414622222222222,
    "postalAddress": [
      {
        "address": "'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n",
        "additionalInfo": "Loja B",
        "districtName": "Paraíso",
        "townName": "São Paulo",
        "ibgeCode": "string",
        "countrySubDivision": "AC",
        "postCode": 1310200,
        "country": "ANDORRA",
        "countryCode": "BRA",
        "geographicCoordinates": {
          "latitude": -89.836518,
          "longitude": -179.836519
        }
      }
    ],
    "access": {
      "standards": [
        {
          "openingTime": "10:00:57Z",
          "closingTime": "16:00:57Z",
          "weekday": "DOMINGO"
        }
      ],
      "email": "Joao.silva@seguradoraa.com.br",
      "site": "https://openinsurance.com.br/aaa",
      "phones": [
        {
          "type": "FIXO",
          "countryCallingCode": 55,
          "areaCode": 11,
          "number": 30041000
        }
      ]
    },
    "services": [
      {
        "name": "ACONSELHAMENTO_SOBRE_PRODUTOS_OFERTADOS",
        "nameOthers": "string",
        "line": [
          "CAPITALIZACAO"
        ]
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
name string true none Nome ou razão social (pessoa jurídica) do intermediário
nameOther string false none No caso da Pessoa jurídica
documentNumber string false none CPF ou CNPJ do intermediário OBS: Opcional para pessoa natural
type string true none Relação de tipos de intermediário
SUSEP string false none Número de Registro SUSEP no caso de intermediário ser Corretor de Seguros. OBS: Condicional a seleção de 1. Corretor de seguros no campo acima
postalAddress IntermediaryCoveragePostalAddress true none none
access IntermediaryAccess false none Forma de acesso.
services IntermediaryServices true none none

Enumerated Values

Property Value
type CORRETOR_DE_SEGUROS
type REPRESENTANTE_DE_SEGUROS
type AGENTES_DE_SEGUROS
type DISTRIBUIDOR_DE_TITULO_DE_CAPITALIZACAO

IntermediaryCoveragePostalAddress

[
  {
    "address": "'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n",
    "additionalInfo": "Loja B",
    "districtName": "Paraíso",
    "townName": "São Paulo",
    "ibgeCode": "string",
    "countrySubDivision": "AC",
    "postCode": 1310200,
    "country": "ANDORRA",
    "countryCode": "BRA",
    "geographicCoordinates": {
      "latitude": -89.836518,
      "longitude": -179.836519
    }
  }
]

Properties

Name Type Required Restrictions Description
address string true none Deverá trazer toda a informação referente ao endereço do intermediário: Tipo de logradouro + Nome do logradouro + Número do Logradouro (se não existir usar ' s/n') + complemento (se houver)
additionalInfo string false none Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir: 'Loja B', 'Fundos', 'Casa 2', 'Lote C'
districtName string false none Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas
townName string true none Localidade: O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado
ibgeCode string true none 7 dígitos (o último é um código verificador).
countrySubDivision string true none Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros:
postCode string true none Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios
country string false none Lista de países vide aba 'Lista de países'
countryCode string false none Código do país de acordo com o código “alpha3” do ISO-3166. p.ex.'BRA'
geographicCoordinates IntermediaryGeographicCoordinates false none none

Enumerated Values

Property Value
countrySubDivision AC
countrySubDivision AL
countrySubDivision AP
countrySubDivision AM
countrySubDivision BA
countrySubDivision CE
countrySubDivision DF
countrySubDivision ES
countrySubDivision GO
countrySubDivision MA
countrySubDivision MT
countrySubDivision MS
countrySubDivision MG
countrySubDivision PA
countrySubDivision PB
countrySubDivision PR
countrySubDivision PE
countrySubDivision PI
countrySubDivision RJ
countrySubDivision RN
countrySubDivision RS
countrySubDivision RO
countrySubDivision RR
countrySubDivision SC
countrySubDivision SP
countrySubDivision SE
countrySubDivision TO
country ANDORRA
country EMIRADOS_ARABES_UNIDOS
country AFEGANISTAO
country ANTIGUA_E_BARBUDA
country ANGUILLA
country ALBANIA
country ARMENIA
country ANTILHAS_HOLANDESAS
country ANGOLA
country ANTARTIDA
country ARGENTINA
country SAMOA_AMERICANA
country AUSTRIA
country AUSTRALIA
country ARUBA
country ILHAS_ALAND
country AZERBAIJAO
country BOSNIA_HERZEGOVINA
country BARBADOS
country BANGLADESH
country BELGICA
country BURKINA_FASSO
country BULGARIA
country BAHREIN
country BURUNDI
country BENIN
country SAO_BARTOLOMEU
country BERMUDAS
country BRUNEI
country BOLIVIA
country BONAIRE_SINT_EUSTATIUS_E_SABA
country BRASIL
country BAHAMAS
country BUTAO
country ILHA_BOUVET_TERRITORIO_DA_NORUEGA
country BOTSUANA
country BELARUS
country BELIZE
country CANADA
country ILHAS_COCOS
country REPUBLICA_DEMOCRATICA_DO_CONGO_EX_ZAIRE
country REPUBLICA_CENTRO_AFRICANA
country CONGO
country SUICA
country COSTA_DO_MARFIM
country ILHAS_COOK
country CHILE
country CAMAROES
country CHINA
country COLOMBIA
country COSTA_RICA
country CUBA
country CABO_VERDE
country CURACAO
country ILHA_NATAL
country CHIPRE
country REPUBLICA_TCHECA
country ALEMANHA
country DJIBUTI
country DINAMARCA
country DOMINICA
country REPUBLICA_DOMINICANA
country ARGELIA
country EQUADOR
country ESTONIA
country EGITO
country SAARA_OCIDENTAL_EX_SPANISH_SAHARA
country ERITREIA
country ESPANHA
country ETIOPIA
country FINLANDIA
country FIJI
country ILHAS_FALKLAND_MALVINAS
country MICRONESIA
country ILHAS_FAROES
country FRANCA
country GABAO
country GRA_BRETANHA_REINO_UNIDO_UK
country GRANADA
country GEORGIA
country GUIANA_FRANCESA
country GUERNSEY
country GANA
country GIBRALTAR
country GROELANDIA
country GAMBIA
country GUINE
country GUADALUPE
country GUINE_EQUATORIAL
country GRECIA
country ILHAS_GEORGIA_DO_SUL_E_SANDWICH_DO_SUL
country GUATEMALA
country GUAM_TERRITORIO_DOS_ESTADOS_UNIDOS
country GUINE_BISSAU
country GUIANA
country HONG_KONG
country ILHAS_HEARD_E_MCDONALD_TERRITORIO_DA_AUSTRALIA
country HONDURAS
country CROACIA_HRVATSKA
country HAITI
country HUNGRIA
country INDONESIA
country IRLANDA
country ISRAEL
country ILHA_DO_HOMEM
country INDIA
country TERRITORIO_BRITANICO_DO_OCEANO_INDICO
country IRAQUE
country IRA
country ISLANDIA
country ITALIA
country JERSEY
country JAMAICA
country JORDANIA
country JAPAO
country KENIA
country KYRGYZSTAN
country CAMBOJA
country KIRIBATI
country ILHAS_COMORES
country SAO_CRISTOVAO_E_NEVIS
country COREIA_DO_NORTE
country COREIA_DO_SUL
country KUAIT
country ILHAS_CAYMAN
country CAZAQUISTAO
country LAOS
country LIBANO
country SANTA_LUCIA
country LIECHTENSTEIN
country SRI_LANKA
country LIBERIA
country LESOTO
country LITUANIA
country LUXEMBURGO
country LATVIA
country LIBIA
country MARROCOS
country MONACO
country MOLDOVA
country MONTENEGRO
country SAO_MARTIM
country MADAGASCAR
country ILHAS_MARSHALL
country MACEDONIA_REPUBLICA_YUGOSLAVA
country MALI
country MYANMA_EX_BURMA
country MONGOLIA
country MACAU
country ILHAS_MARIANAS_DO_NORTE
country MARTINICA
country MAURITANIA
country MONTSERRAT
country MALTA
country MAURICIO
country MALDIVAS
country MALAUI
country MEXICO
country MALASIA
country MOCAMBIQUE
country NAMIBIA
country NOVA_CALEDONIA
country NIGER
country ILHAS_NORFOLK
country NIGERIA
country NICARAGUA
country HOLANDA
country NORUEGA
country NEPAL
country NAURU
country NIUE
country NOVA_ZELANDIA
country OMA
country PANAMA
country PERU
country POLINESIA_FRANCESA
country PAPUA_NOVA_GUINE
country FILIPINAS
country PAQUISTAO
country POLONIA
country ST_PIERRE_AND_MIQUELON
country ILHA_PITCAIRN
country PORTO_RICO
country TERRITORIOS_PALESTINOS_OCUPADOS
country PORTUGAL
country PALAU
country PARAGUAI
country QATAR
country ILHA_REUNIAO
country ROMENIA
country SERVIA
country FEDERACAO_RUSSA
country RUANDA
country ARABIA_SAUDITA
country ILHAS_SOLOMAO
country ILHAS_SEYCHELLES
country SUDAO
country SUECIA
country CINGAPURA
country SANTA_HELENA
country ESLOVENIA
country ILHAS_SVALBARD_E_JAN_MAYEN
country ESLOVAQUIA
country SERRA_LEOA
country SAN_MARINO
country SENEGAL
country SOMALIA
country SURINAME
country SUDAO_DO_SUL
country SAO_TOME_E_PRINCIPE
country EL_SALVADOR
country SAO_MARTINHO_PARTE_HOLANDESA
country SIRIA
country SUAZILANDIA
country ILHAS_TURKS_E_CAICOS
country CHADE
country TERRITORIOS_DO_SUL_DA_FRANCA
country TOGO
country TAILANDIA
country TADJIQUISTAO
country ILHAS_TOKELAU
country TIMOR_LESTE_EX_EAST_TIMOR
country TURCOMENISTAO
country TUNISIA
country TONGA
country TURQUIA
country TRINIDAD_AND_TOBAGO
country TUVALU
country TAIWAN
country TANZANIA
country UCRANIA
country UGANDA
country ILHAS_MENORES_DOS_ESTADOS_UNIDOS
country ESTADOS_UNIDOS
country URUGUAI
country UZBEQUISTAO
country VATICANO
country SAINT_VINCENTE_E_GRANADINAS
country VENEZUELA
country ILHAS_VIRGENS_INGLATERRA
country ILHAS_VIRGENS_ESTADOS_UNIDOS
country VIETNAM
country VANUATU
country ILHAS_WALLIS_E_FUTUNA
country SAMOA_OCIDENTAL
country IEMEN
country MAYOTTE
country AFRICA_DO_SUL
country ZAMBIA
country ZIMBABUE

IntermediaryGeographicCoordinates

{
  "latitude": -89.836518,
  "longitude": -179.836519
}

Properties

Name Type Required Restrictions Description
latitude string false none Informação da Latitude referente a geolocalização informada. Entre -90 e 90. Formato numérico 2 casas antes da vírgula, 11 posições.
longitude string false none Informação da Longitude referente a geolocalização informada. Formato numérico 3 casas antes da vírgula, 11 posições. Entre -180 e 180.

IntermediaryAccess

{
  "standards": [
    {
      "openingTime": "10:00:57Z",
      "closingTime": "16:00:57Z",
      "weekday": "DOMINGO"
    }
  ],
  "email": "Joao.silva@seguradoraa.com.br",
  "site": "https://openinsurance.com.br/aaa",
  "phones": [
    {
      "type": "FIXO",
      "countryCallingCode": 55,
      "areaCode": 11,
      "number": 30041000
    }
  ]
}

Forma de acesso.

Properties

Name Type Required Restrictions Description
standards IntermediaryStandards false none none
email string false none Endereço de e-mail
site string false none Campo aberto As URLs são limitadas a 2048 caracteres, mas, para o contexto do Open Insurance, foi adotado a metade deste tamanho (1024).
phones IntermediaryPhones false none Telefone do intermediário

IntermediaryStandards

[
  {
    "openingTime": "10:00:57Z",
    "closingTime": "16:00:57Z",
    "weekday": "DOMINGO"
  }
]

Properties

Name Type Required Restrictions Description
openingTime string false none Horário de abertura
closingTime string false none Horário de encerramento
weekday string false none Dias de funcionamento

Enumerated Values

Property Value
weekday DOMINGO
weekday SEGUNDA_FEIRA
weekday TERCA_FEIRA
weekday QUARTA_FEIRA
weekday QUINTA_FEIRA
weekday SEXTA_FEIRA
weekday SABADO

IntermediaryPhones

[
  {
    "type": "FIXO",
    "countryCallingCode": 55,
    "areaCode": 11,
    "number": 30041000
  }
]

Telefone do intermediário

Properties

Name Type Required Restrictions Description
type string false none Identificação do Tipo de telefone do intermediário
countryCallingCode string false none Número de DDI (Discagem Direta Internacional) para telefone de acesso ao Canal - se houver.
areaCode string false none Número de DDD (Discagem Direta à Distância) do telefone do intermediário - se houver. p.ex. '19'
number string false none Número de telefone do intermediário - se houver

IntermediaryServices

[
  {
    "name": "ACONSELHAMENTO_SOBRE_PRODUTOS_OFERTADOS",
    "nameOthers": "string",
    "line": [
      "CAPITALIZACAO"
    ]
  }
]

Properties

Name Type Required Restrictions Description
name string true none Relação dos serviços efetivamente prestados, conforme discriminado na Tabela II.3 do Anexo II
nameOthers string false none Campo aberto para descrição em caso de seleção de Outras na lista padronizada de Tipo de Serviço Prestado por Intermediário
line [string] true none none

Enumerated Values

Property Value
name ANGARIACAO_PROMOCAO_INTERMEDIACAO_OU_DISTRIBUICAO_DE_PRODUTOS
name ACONSELHAMENTO_SOBRE_PRODUTOS_OFERTADOS
name RECEPCAO_DE_PROPOSTAS_E_EMISSAO_DE_DOCUMENTOS_CONTRATUAIS
name SUBSCRICAO_DE_RISCOS_RELACIONADOS_A_PRODUTOS_DE_SEGUROS
name COLETA_E_FORNECIMENTO_A_SOCIEDADE_PARTICIPANTE_DE_DADOS_CADASTRAIS_E_DE_DOCUMENTACAO_DE_CLIENTES_E_SE_FOR_O_CASO_ESTIPULANTES_CORRETORES_DE_SEGUROS_E_SEUS_PREPOSTOS
name RECOLHIMENTO_DE_PREMIOS_E_CONTRIBUICOES
name RECEBIMENTO_DE_AVISOS_DE_SINISTROS
name REGULACAO_DE_SINISTROS
name PAGAMENTO_DE_INDENIZACAO_BENEFICIO
name ORIENTACAO_E_ASSISTENCIA_AOS_CLIENTES_NO_QUE_COMPETE_AOS_CONTRATOS_COMERCIALIZADOS
name APOIO_LOGISTICO_E_OPERACIONAL_A_SOCIEDADE_PARTICIPANTE_NA_GESTAO_E_EXECUCAO_DE_CONTRATOS
name OUTROS

{
  "self": "https://api.organizacao.com.br/open-insurance/channels/v1",
  "first": "https://api.organizacao.com.br/open-insurance/channels/v1",
  "prev": "https://api.organizacao.com.br/open-insurance/channels/v1",
  "next": "https://api.organizacao.com.br/open-insurance/channels/v1",
  "last": "https://api.organizacao.com.br/open-insurance/channels/v1"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

Meta

{
  "totalRecords": 10,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

ResponseError

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "requestDateTime": "2021-08-20T08:30:00Z"
    }
  ],
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
errors [object] true none none
» code string true none Código de erro específico do endpoint
» title string true none Título legível por humanos deste erro específico
» detail string true none Descrição legível por humanos deste erro específico
» requestDateTime string(date-time) false none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
meta Meta false none none

ResponsePhoneChannelsList

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-insurance",
          "phoneChannels": [
            {
              "identification": {
                "type": "CENTRAL_TELEFONICA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "35721199"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "997865532"
                  }
                ]
              },
              "services": [
                {
                  "name": "ALTERACACOES_FORMA_PAGAMENTO",
                  "code": "01"
                },
                {
                  "name": "AVISO_SINISTRO",
                  "code": "02"
                },
                {
                  "name": "ENDOSSO",
                  "code": "05"
                }
              ]
            },
            {
              "identification": {
                "type": "SAC",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACAO",
                  "code": "16"
                },
                {
                  "name": "PORTABILIDADE",
                  "code": "15"
                },
                {
                  "name": "ENDOSSO",
                  "code": "05"
                }
              ]
            },
            {
              "identification": {
                "type": "OUVIDORIA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACAO",
                  "code": "16"
                },
                {
                  "name": "PORTABILIDADE",
                  "code":