Previdência - Cliente - Certificado (Experimental (v2))

Histórico de modificações da API

Certificado - Extratos Detalhados

Obter detalhes do extrato do Certificado

Experimente

Solicitar URL

Parâmetros de solicitação

string

Identificação do Cliente - CPF

string

Identificação do Certificado

string

Data inicial do período desejado (yyyy-MM-dd).

string

Data final do período desejado (yyyy-MM-dd).

Cabeçalhos de solicitação

string

Código da Empresa

string
A chave de API atribuída a um indivíduo para acessar a API. Você pode encontrar a chave de API em sua conta.

Corpo da solicitação

Resposta 200

OK

{
  "certificado": {
    "participante": {
      "matricula": "00304408",
      "nome": "PHELLIPPE SILVA",
      "idade": 27
    },
    "tipoProduto": "VGBL",
    "dataImplantacao": "2016-02-03T00:00:00",
    "plano": {
      "nome": "VGBL INDIVIDUAL GRÇ879 FUTURO",
      "susep": "23412.901338/2022-19"
    },
    "status": "ATIVO",
    "fatorAposentadoria": 0.00605043,
    "tabuaAtuarial": "FATOR DE RENDA MENSAL TEMPORÁRIA 15 ANOS AT2000MF COM 0%",
    "regimeTributacao": "TABELA REGRESSIVA",
    "tipoRenda": "Renda Mensal Temporária",
    "pagamento": {
      "periodicidade": "MENSAL",
      "forma": "CARNE"
    },
    "fundos": [
      {
        "codigo": "GEFUT",
        "nome": "GRÇ879 FUTURO PREVIDENCIARIO FIC DE FI MULTIMERCADO",
        "cnpj": "98059356000336",
        "taxaAdministracao": 1.95,
        "saldos": [
          {
            "data": "2016-08-01T00:00:00",
            "saldo": 9086.23,
            "quantidadeCotas": 7289.95975405,
            "valorCota": 1.24640338
          },
          {
            "data": "2016-10-11T00:00:00",
            "saldo": 9603.17,
            "quantidadeCotas": 7528.52303784,
            "valorCota": 1.27556756
          }
        ],
        "reserva": {
          "cotaTotal": 7528.52303784,
          "reservaTotal": 9603.17,
          "carregamentoSaidaTotal": 7.5,
          "reservaLiquidaTotal": 9233.99,
          "reservasAliquotas": [
            {
              "aliquota": 10,
              "cota": 0,
              "reserva": 0,
              "carregamentoSaida": 0,
              "reservaLiquida": 0
            },
            {
              "aliquota": 15,
              "cota": 0,
              "reserva": 0,
              "carregamentoSaida": 0,
              "reservaLiquida": 0
            },
            {
              "aliquota": 20,
              "cota": 0,
              "reserva": 0,
              "carregamentoSaida": 0,
              "reservaLiquida": 0
            },
            {
              "aliquota": 25,
              "cota": 4200.74425497,
              "reserva": 5358.36,
              "carregamentoSaida": 0,
              "reservaLiquida": 5096.47
            },
            {
              "aliquota": 30,
              "cota": 3327.77878287,
              "reserva": 4244.81,
              "carregamentoSaida": 7.5,
              "reservaLiquida": 4137.53
            },
            {
              "aliquota": 35,
              "cota": 0,
              "reserva": 0,
              "carregamentoSaida": 0,
              "reservaLiquida": 0
            }
          ]
        },
        "rentabilidade": {
          "periodo": {
            "dataReferenciaInicial": "2016-08-01T00:00:00",
            "dataReferenciaFinal": "2016-10-11T00:00:00",
            "rentabilidade": 2.3398668896420998
          },
          "dia": {
            "dataReferencia": "2016-10-11T00:00:00",
            "rentabilidade": 0
          },
          "mes": {
            "dataReferenciaInicial": "2016-09-30T00:00:00",
            "dataReferenciaFinal": "2016-10-11T00:00:00",
            "rentabilidade": 0.77497500016294585
          },
          "mesAnterior": {
            "dataReferenciaInicial": "2016-08-31T00:00:00",
            "dataReferenciaFinal": "2016-09-30T00:00:00",
            "rentabilidade": 0.76192153829570086
          },
          "ano": {
            "dataReferenciaInicial": "2015-12-31T00:00:00",
            "dataReferenciaFinal": "2016-10-11T00:00:00",
            "rentabilidade": 6.0768698151646694
          },
          "em12Meses": {
            "dataReferenciaInicial": "2015-10-23T00:00:00",
            "dataReferenciaFinal": "2016-10-11T00:00:00",
            "rentabilidade": 8.26339510742084
          },
          "em24Meses": {
            "dataReferenciaInicial": "2014-10-30T00:00:00",
            "dataReferenciaFinal": "2016-10-11T00:00:00",
            "rentabilidade": 23.198873062865523
          },
          "em36Meses": {
            "dataReferenciaInicial": "2013-11-07T00:00:00",
            "dataReferenciaFinal": "2016-10-11T00:00:00",
            "rentabilidade": 27.556756
          },
          "observacao": "A apuração das rentabilidades é feita entre o dia útil anterior ao início do período e o último dia útil do período. A rentabilidade diária é calculada considerando o fechamento da última cota do fundo."
        },
        "movimentos": [
          {
            "numero": "58340596",
            "tipo": "APL",
            "descricao": "CONTRIBUICAO - APLICACAO",
            "dataMovimento": "2016-08-15T00:00:00",
            "valorBruto": 150,
            "valorLiquido": 150,
            "valorCarregamento": 0,
            "dataCotizacao": "2016-08-16T00:00:00",
            "quantidadeCotas": 119.75006342,
            "saldo": 150.000000005459,
            "saldoEmCotas": 119.75006342,
            "valorIR": 0,
            "valorCota": 1.25260894
          },
          {
            "numero": "58976941",
            "tipo": "APL",
            "descricao": "CONTRIBUICAO - APLICACAO",
            "dataMovimento": "2016-09-19T00:00:00",
            "valorBruto": 150,
            "valorLiquido": 150,
            "valorCarregamento": 0,
            "dataCotizacao": "2016-09-20T00:00:00",
            "quantidadeCotas": 118.81322037,
            "saldo": 150.00000000499912,
            "saldoEmCotas": 118.81322037,
            "valorIR": 0,
            "valorCota": 1.26248577
          }
        ]
      }
    ]
  }
}
{
  "type": "object",
  "properties": {
    "certificado": {
      "type": "object",
      "properties": {
        "participante": {
          "type": "object",
          "properties": {
            "matricula": {
              "type": "string"
            },
            "nome": {
              "type": "string"
            },
            "idade": {
              "format": "int32",
              "type": "integer"
            }
          }
        },
        "tipoProduto": {
          "type": "string"
        },
        "dataImplantacao": {
          "format": "date-time",
          "type": "string"
        },
        "plano": {
          "type": "object",
          "properties": {
            "nome": {
              "type": "string"
            },
            "susep": {
              "type": "string"
            }
          }
        },
        "status": {
          "type": "string"
        },
        "fatorAposentadoria": {
          "format": "double",
          "type": "number"
        },
        "tabuaAtuarial": {
          "type": "string"
        },
        "regimeTributacao": {
          "type": "string"
        },
        "tipoRenda": {
          "type": "string"
        },
        "pagamento": {
          "type": "object",
          "properties": {
            "periodicidade": {
              "type": "string"
            },
            "forma": {
              "type": "string"
            }
          }
        },
        "fundos": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "codigo": {
                "type": "string"
              },
              "nome": {
                "type": "string"
              },
              "cnpj": {
                "type": "string"
              },
              "taxaAdministracao": {
                "format": "double",
                "type": "number"
              },
              "saldos": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "format": "date-time",
                      "type": "string"
                    },
                    "saldo": {
                      "format": "double",
                      "type": "number"
                    },
                    "quantidadeCotas": {
                      "format": "double",
                      "type": "number"
                    },
                    "valorCota": {
                      "format": "double",
                      "type": "number"
                    }
                  }
                }
              },
              "reserva": {
                "type": "object",
                "properties": {
                  "cotaTotal": {
                    "format": "double",
                    "type": "number"
                  },
                  "reservaTotal": {
                    "format": "double",
                    "type": "number"
                  },
                  "carregamentoSaidaTotal": {
                    "format": "double",
                    "type": "number"
                  },
                  "reservaLiquidaTotal": {
                    "format": "double",
                    "type": "number"
                  },
                  "reservasAliquotas": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "aliquota": {
                          "format": "double",
                          "type": "number"
                        },
                        "cota": {
                          "format": "double",
                          "type": "number"
                        },
                        "reserva": {
                          "format": "double",
                          "type": "number"
                        },
                        "carregamentoSaida": {
                          "format": "double",
                          "type": "number"
                        },
                        "reservaLiquida": {
                          "format": "double",
                          "type": "number"
                        }
                      }
                    }
                  }
                }
              },
              "rentabilidade": {
                "type": "object",
                "properties": {
                  "periodo": {
                    "type": "object",
                    "properties": {
                      "dataReferenciaInicial": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "dataReferenciaFinal": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "rentabilidade": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  },
                  "dia": {
                    "type": "object",
                    "properties": {
                      "dataReferencia": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "rentabilidade": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  },
                  "mes": {
                    "type": "object",
                    "properties": {
                      "dataReferenciaInicial": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "dataReferenciaFinal": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "rentabilidade": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  },
                  "mesAnterior": {
                    "type": "object",
                    "properties": {
                      "dataReferenciaInicial": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "dataReferenciaFinal": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "rentabilidade": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  },
                  "ano": {
                    "type": "object",
                    "properties": {
                      "dataReferenciaInicial": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "dataReferenciaFinal": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "rentabilidade": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  },
                  "em12Meses": {
                    "type": "object",
                    "properties": {
                      "dataReferenciaInicial": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "dataReferenciaFinal": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "rentabilidade": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  },
                  "em24Meses": {
                    "type": "object",
                    "properties": {
                      "dataReferenciaInicial": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "dataReferenciaFinal": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "rentabilidade": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  },
                  "em36Meses": {
                    "type": "object",
                    "properties": {
                      "dataReferenciaInicial": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "dataReferenciaFinal": {
                        "format": "date-time",
                        "type": "string"
                      },
                      "rentabilidade": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  },
                  "observacao": {
                    "type": "string"
                  }
                }
              },
              "movimentos": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "numero": {
                      "type": "string"
                    },
                    "tipo": {
                      "type": "string"
                    },
                    "descricao": {
                      "type": "string"
                    },
                    "dataMovimento": {
                      "format": "date-time",
                      "type": "string"
                    },
                    "valorBruto": {
                      "format": "double",
                      "type": "number"
                    },
                    "valorLiquido": {
                      "format": "double",
                      "type": "number"
                    },
                    "valorCarregamento": {
                      "format": "double",
                      "type": "number"
                    },
                    "dataCotizacao": {
                      "format": "date-time",
                      "type": "string"
                    },
                    "quantidadeCotas": {
                      "format": "double",
                      "type": "number"
                    },
                    "saldo": {
                      "format": "double",
                      "type": "number"
                    },
                    "saldoEmCotas": {
                      "format": "double",
                      "type": "number"
                    },
                    "valorIR": {
                      "format": "double",
                      "type": "number"
                    },
                    "valorCota": {
                      "format": "double",
                      "type": "number"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 400

Bad Request

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 401

Unauthorized

Resposta 404

Resposta 422

Unprocessable Entity

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 500

InternalServerError

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Exemplos de código

@ECHO OFF

curl -v -X GET "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}"
-H "CodigoEmpresa: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
namespace CSHttpClientSample
{
    using System;
    using System.Net.Http.Headers;
    using System.Text;
    using System.Net.Http;
    using System.Web;

    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("CodigoEmpresa", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("CodigoEmpresa", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("CodigoEmpresa","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"CodigoEmpresa"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'CodigoEmpresa' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'CodigoEmpresa': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.icatuseguros.com.br')
    conn.request("GET", "/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'CodigoEmpresa': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.icatuseguros.com.br')
    conn.request("GET", "/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}/extratos-detalhados?DataInicial={DataInicial}&DataFinal={DataFinal}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['CodigoEmpresa'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body